친지인은 기여해 주실 개발자분들을 언제나 환영합니다! 어떤 종류의 기여던 따뜻한 충고로 받아들이고 즉각적으로 반영할 준비가 되어있습니다.
다만 기여하기 전에 각 섹션에 해당하는 글들을 읽어주시고 작성해주시면 감사하겠습니다🙏
maintainer들이 기여 제보를 처음부터 끝까지 꼼꼼히 받고 더 나은 코드를 위해 노력할 수 있게 도와주세요.
이 프로젝트에 대해 궁금한 것이 생겼거나, 어떻게 작동시키거나 정정할 사항이 있다면 다음 절차를 따라주세요.
- https://github.com/tjwjdgus12/ChinJiIn/issues 에서 Issue를 열어주세요.
- 도움이 필요하다면 tag: help wanted, tag : question을 달아주세요.
- 버그나 에러는 tag: bug를 달아주세요.
- 어떤 환경에서 일어난 일인지에 대해서 최대한 자세하게 작성해주세요.
- 관련되어 보이는 모든 환경 요소, Input 예시, Output 예시를 제공해주세요.
각 issue에 해당하는 사람을 assign 해주시면 더 빠른 피드백이 가능합니다!
| 내용 | Assignee |
|---|---|
| 한글에서 천지인 시퀀스로 변환 (cji_converter 관련) | @redjen8 |
| 천지인 시퀀스에서 한글로 변환 (han_converter 관련) | @SuperChobo |
| 천지인 자판의 물리적 거리 (edit_distance_calculater 관련) | @ChangminYi |
| 한글 사전 (Dictionary/ 관련) | @kindkiz |
| word_fixer의 단어 교정 (word_fixer 및 chinjiin 모듈 관련) | @tjwjdgus12 |
Issue를 올리시면
- 최대한 빨리 답변드리도록 노력하겠습니다! 답변을 확인하고 나서 추가로 label이 달릴 수 있으니 꼭 확인해주세요.
- Issue에 대한 답변 이후 contributer님의 피드백이 30일 이후에 오지 않으면 관련 Issue는 닫히게 됩니다. 만약 닫힌 Issue에 대해서 다시 제보하실 내용이 있다면 관련된 Issue 번호를 같이 작성해서 다시 올려주세요.
작은 변경을 위한 짧은 코드서부터 큰 기능을 추가하기 위한 긴 코드 기여까지 모두 환영합니다!
코드를 기여하려면,
- 소스 코드에 유의미한 변경 사항을 작성해주세요.
- 변경된 코드에 대한 자세한 주석을 꼭 달아주세요.
- 더 빠른 피드백을 위해 PEP8 코딩 스타일을 적용해서 작성하셨는지 한번 더 확인해주세요.
- 테스트를 꼭 거쳤는지 확인해주세요. 가령 특수한 (숫자, 띄어쓰기, 한글이 아닌, 인코딩이 다른) 입력들에 대해서 어떻게 작동하는지 확인해주셨으면 합니다.
- 커밋 메시지는 핵심 내용을 잘 나타나게 최대한 깔끔하게 작성해주세요.
- https://github.com/tjwjdgus12/ChinJiIn/pulls 에 가서 PR을 작성해주세요.
- 작성하신 PR이 하나 이상의 Issue와 관련이 있는 내용이라면, PR Description에 반드시
#{몇 번째}issue에 관련되어 있는지 써주세요.
PR을 다 작성하셨다면,
- 특별한 경우가 아니면 Maintainer들이 바로 Code Review에 들어갑니다.
- Maintainer들이 어떤 사항에 대해 변경을 요구하거나, 편집하거나, 다른 Maintainer들을 태그해서 review를 요청할 수 있습니다. 이 과정에서 PR에 추가적으로 tag가 달릴 수 있습니다.
- 개발자님의 코드 기여에 대해서 늘 감사합니다. 만약 PR이 Reject 되었다면 왜 변경 사항이 받아들여지지 않았는지에 대한 자세한 이유를 답변해드릴 것입니다. Reject 된 PR도 물론 감사히 받아들이고 있습니다. 더 나은 코드가 생각나셨다면 거리낌 없이 기여해주세요. 😀
- PR이 Accept 된다면
mainbranch에 빠른 시일내로 merge 될 예정입니다.