|
| 1 | +# 기여하기 |
| 2 | + |
| 3 | +<p align="center"> |
| 4 | + <a href="CONTRIBUTING.md">English</a> | |
| 5 | + <a href="CONTRIBUTING.zh-CN.md">简体中文</a> | |
| 6 | + <a href="CONTRIBUTING.de-DE.md">Deutsch</a> | |
| 7 | + <a href="CONTRIBUTING.fr-FR.md">Français</a> | |
| 8 | + <a href="CONTRIBUTING.es-ES.md">Español</a> | |
| 9 | + <span>한국어</span> |
| 10 | +</p> |
| 11 | + |
| 12 | +## 과정 |
| 13 | + |
| 14 | +1. 구현하고 싶은 변경 사항을 설명하는 이슈를 제출합니다. 사소한 변경이나 버그 수정인 경우 3단계로 건너뛰어도 됩니다. |
| 15 | +2. 이슈에서 범위가 논의된 후, 자신에게 할당합니다. OpenBot 프로젝트의 "해야 할 일" 열에 나타나야 합니다. |
| 16 | +3. 프로젝트를 포크하고 로컬로 클론합니다: |
| 17 | + |
| 18 | + `git clone https://github.com/<user_id>/OpenBot.git` |
| 19 | + |
| 20 | +4. 브랜치를 생성합니다: |
| 21 | + |
| 22 | + `git checkout -b <branch-name>` |
| 23 | + |
| 24 | + 여기서 `<branch-name>`은 작업의 범위를 간결하게 설명합니다. |
| 25 | + |
| 26 | +5. 작업을 수행하고, 좋은 커밋 메시지를 작성한 후, 포크한 저장소에 브랜치를 푸시합니다: |
| 27 | + |
| 28 | + ```bash |
| 29 | + git add <modified file> |
| 30 | + git commit -m <meaningful description> |
| 31 | + git push --set-upstream origin <branch-name> |
| 32 | + ``` |
| 33 | + |
| 34 | +6. GitHub에서 [풀 리퀘스트 요청](https://github.com/intel-isl/OpenBot/pulls)을 생성하고 이슈에 연결합니다. OpenBot 프로젝트의 "진행 중" 열에 나타나야 합니다. |
| 35 | +7. 받을 수 있는 코드 리뷰 피드백을 반영하여 포크한 저장소에 푸시합니다. 풀 요청은 자동으로 업데이트됩니다. |
| 36 | +8. 세상을 더 나은 곳으로 만들었다는 보상으로 원하는 음료를 마십니다. |
| 37 | + |
| 38 | +## 가이드라인 |
| 39 | + |
| 40 | +- 나머지 코드와 동일한 스타일과 포맷을 사용합니다. |
| 41 | + - Java (Android) 및 Python 코드에 대한 내용은 [아래](#Formatting)를 참조하세요. |
| 42 | + - 다른 코드의 경우, 가능한 한 잘 어울리도록 노력하세요. |
| 43 | +- 변경한 코드와 관련된 문서를 업데이트합니다. |
| 44 | +- 제3자 종속성을 포함하고 싶다면, 먼저 이슈에서 논의하세요. |
| 45 | +- 풀 요청은 가능한 한 적은 변경으로 단일 기능을 구현해야 합니다. |
| 46 | +- 임시 파일이나 바이너리 파일이 포함되지 않도록 합니다 (gitignore가 대부분 이를 처리해야 합니다). |
| 47 | +- 풀 요청을 제출하기 전에 마스터 브랜치를 자신의 브랜치에 리베이스/머지합니다. |
| 48 | +- 가능하다면 Windows, Linux 및 OSX에서 코드를 테스트합니다. |
| 49 | + |
| 50 | +## 초기화 |
| 51 | + |
| 52 | +### Java |
| 53 | + |
| 54 | +Java 코드를 포맷하기 위해 gradle 스크립트를 사용합니다. `android` 디렉토리에 있어야 합니다. |
| 55 | + |
| 56 | +코드를 확인하려면 다음을 사용하세요: |
| 57 | + |
| 58 | +```bash |
| 59 | +./gradlew checkStyle |
| 60 | +``` |
| 61 | + |
| 62 | +모든 파일에 스타일을 적용하려면 다음을 실행합니다: |
| 63 | + |
| 64 | +```bash |
| 65 | +./gradlew applyStyle |
| 66 | +``` |
| 67 | + |
| 68 | +### Python |
| 69 | + |
| 70 | +Python 코드 포맷에는 [black](https://pypi.org/project/black/)을 사용합니다. |
| 71 | + |
| 72 | +현재 디렉토리의 코드를 확인하려면: |
| 73 | + |
| 74 | +```bash |
| 75 | +black --check . |
| 76 | +``` |
| 77 | + |
| 78 | +현재 디렉토리의 모든 파일에 스타일을 적용하려면: |
| 79 | + |
| 80 | +```bash |
| 81 | +black . |
| 82 | +``` |
| 83 | + |
| 84 | +## 추가 자료 |
| 85 | + |
| 86 | +오픈 소스 프로젝트에 기여하는 방법에 대한 더 많은 정보가 필요하다면, 다음 두 가지 참고 자료를 추천합니다: |
| 87 | + |
| 88 | +- [오픈 소스에 기여하는 방법](http://opensource.guide/how-to-contribute/) |
| 89 | +- [GitHub 프로젝트에 기여하는 초보자 가이드](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/) |
| 90 | + |
| 91 | +감사합니다! |
0 commit comments