HOW-TO-CONTRIBUTE.md

목차

• How to contrubute
• 시작하기에 앞서
  • 데이터 작성 규칙
• 목차
• README.md
  • 1. Fork this repository
  • 2. Clone forked repository
  • 3. Commit your changes
  • 4. Push your commit
  • 5. Register pull request for your commit
  • 6. Pull request has been approved
• Website
  • 1. Fork this repository
  • 2. Clone forked repository
  • 3. Install depencies
  • 4. Start website
  • 5. Commit your changes
  • 6. Push your commit
  • 7. Register pull request for your commit
  • 8. Pull request has been approved
• Android
  • 1. Fork this repository
  • 2. Clone forked repository
  • 3. Open Android Studio
  • 4. Start android
  • 5. Commit your changes
  • 6. Push yout commit
  • 7. Register pull requerst for your commit
  • 8. Pull request has been approved

How to contribute

아래의 방법으로 Pull Request를 올려주시면 됩니다.
Site For Developers는 GitHub README.md, 웹사이트로 구성되어 있습니다.
지금 기여하셔서 Site For Developers를 더 유익하고 편리한 레포지토리로 만들어 주세요!

시작하기에 앞서

데이터 작성 규칙

• 데이터 작성은 아래의 작성 형식을 따르면 됩니다.
  • title 태그는 웹사이트 head의 <title>을 작성하시면 됩니다.
  • content 태그는 웹사이트 head의 을 작성하시면 됩니다.
    • description이 존재하지 않는다면 title로 대체하여 주시기 바랍니다.
    • description이 영어로 작성되어 있다면 한국어로 번역해주시기 바랍니다.
    • description이 두 문장 이상이라면 처음 문장만 작성해주시기 바랍니다.
  • feature 태그는 웹사이트의 특징을 아래에서 골라 작성하시면 됩니다. (무료: free / 유료 혹은 부분적 유료: pay / 한국어: korean / 영어: english / 오픈소스: opensource)
  • link 태그는 웹사이트의 주소를 작성하시면 됩니다.

{
"title": "",
"content": "",
"feature": [""],
"link": ""
}

README.md

1. Fork this repository

이 레포지토리를 포크해 주세요. 포크하는법

2. Clone forked repository

포크한 레포지토리를 클론해 주세요.

$ git clone https://github.com/[username]/site-for-developers.git
$ cd site-for-developers

3. Commit your changes

변경사항을 만들고 커밋해주세요.

$ git add .
$ git commit -m "[your description]"

4. Push your commit

커밋을 포크한 레포지토리로 푸쉬해 주세요.

⚠ 이 명령어에서 'origin'은 당신이 포크한 레포지토리여야 합니다.

$ git push origin main

5. Register pull request for your commit

Pull Request를 등록해 주세요. Pull Request 등록하는법

6. Pull request has been approved

🎉 관리자에 의해 Pull Request가 승인되면 기여자 명단에 올라가게 됩니다 🎉

Website

1. Fork this repository

이 레포지토리를 포크해 주세요. 포크하는법

포크하는 과정에서 "Copy the main branch only"의 체크박스를 해제해주세요.

2. Clone forked repository

포크한 레포지토리를 클론해 주세요.

$ git clone -b website https://github.com/[username]/site-for-developers.git
$ cd site-for-developers

3. Install depencies

필요한 의존성들을 설치해주세요.

$ pnpm install

4. Start website

해당 웹사이트를 실행해보세요.

$ pnpm start

5. Commit your changes

현재까지 아무런 문제가 없다면 변경사항을 만들고 커밋해주세요.

$ git add .
$ git commit -m "[your description]"

6. Push your commit

커밋을 포크한 레포지토리로 푸쉬해 주세요.

⚠ 이 명령어에서 'origin'은 당신이 포크한 레포지토리의 리모트여야 합니다.

$ git push origin website

7. Register pull request for your commit

Pull Request를 등록해 주세요. Pull Request 등록하는법

8. Pull request has been approved

🎉 관리자에 의해 Pull Request가 승인되면 기여자 명단에 올라가게 됩니다 🎉

Android

1. Fork this repository

이 레포지토리를 포크해 주세요. 포크하는법

포크하는 과정에서 "Copy the main branch only"의 체크박스를 해제해주세요.

2. Clone forked repository

포크한 레포지토리를 클론해 주세요.

$ git clone -b website https://github.com/[username]/site-for-developers.git
$ cd site-for-developers

3. Open Android Studio

Android Studio를 실행해 주세요. Android Studio 설치하는법, Android Studio 실행하는법

4. Start android

Android app을 실행해보세요. Android app 실행하는법

5. Commit your changes

현재까지 아무런 문제가 없다면 변경사항을 만들고 커밋해주세요.

$ git add .
$ git commit -m "[your description]"

6. Push yout commit

커밋을 포크한 레포지토리로 푸쉬해 주세요.

⚠ 이 명령어에서 'origin'은 당신이 포크한 레포지토리의 리모트여야 합니다.

$ git push origin android

7. Register pull requerst for your commit

Pull Request를 등록해 주세요. Pull Request 등록하는법

8. Pull request has been approved

🎉 관리자에 의해 Pull Request가 승인되면 기여자 명단에 올라가게 됩니다 🎉