Awesome-Python-Projects에 기여하기
여러분의 의견을 환영합니다! 저희는 이 프로젝트에 기여하는 과정을 가능한 한 쉽고 투명하게 만들고 싶습니다. 기여의 종류는 다음과 같습니다:
- 버그 신고
- 코드의 현재 상태에 대한 논의
- 수정 사항 제출
- 새로운 기능 제안
- 관리자 되기
저희는 깃허브로 개발합니다
저희는 코드를 호스팅하고, 이슈와 기능 요청을 추적하며, 풀 리퀘스트를 받기 위해 깃허브를 사용합니다.
저희는 깃허브 플로우를 사용하므로, 모든 코드 변경은 풀 리퀘스트를 통해 이루어집니다
풀 리퀘스트는 코드베이스에 변경 사항을 제안하는 가장 좋은 방법입니다(저희는 깃허브 플로우를 사용합니다). 저희는 여러분의 풀 리퀘스트를 적극적으로 환영합니다:
- 리포지토리를 포크하고
master에서 브랜치를 생성하세요. - 테스트가 필요한 코드를 추가했다면, 테스트를 추가하세요.
- API를 변경했다면, 문서를 업데이트하세요.
- 테스트 스위트가 통과하는지 확인하세요.
- 코드가 린트 규칙을 준수하는지 확인하세요.
- 풀 리퀘스트를 보내주세요!
여러분이 기여하는 모든 내용은 MIT 소프트웨어 라이선스 하에 있습니다
요약하자면, 여러분이 코드 변경 사항을 제출할 때, 여러분의 제출물은 프로젝트를 포괄하는 동일한 MIT 라이선스 하에 있는 것으로 간주됩니다. 이것이 우려된다면 관리자에게 자유롭게 연락하세요.
깃허브의 이슈를 사용하여 버그를 신고하세요
저희는 공개 버그를 추적하기 위해 깃허브 이슈를 사용합니다. 새로운 이슈를 열어 버그를 신고하세요. 정말 쉽습니다!
상세 정보, 배경, 샘플 코드를 포함하여 버그 보고서를 작성하세요
훌륭한 버그 보고서는 다음과 같은 경향이 있습니다:
- 간략한 요약 및/또는 배경
- 재현 단계
- 구체적으로 작성하세요!
- 가능하다면 샘플 코드를 제공하세요.
- 예상했던 결과
- 실제로 발생한 일
- 참고 사항 (이것이 왜 발생한다고 생각하는지에 대한 내용이나, 시도했지만 작동하지 않았던 내용 포함 가능)
사람들은 철저한 버그 보고서를 정말 좋아합니다. 농담이 아닙니다.
일관된 코딩 스타일 사용하기
이 내용은 페이스북의 가이드라인에서 다시 한번 빌려왔습니다.
- 탭 대신 2칸 띄어쓰기로 들여쓰기
- 스타일 통일을 위해
npm run lint를 실행해 볼 수 있습니다
라이선스
기여함으로써, 귀하는 귀하의 기여가 MIT 라이선스 하에 라이선스된다는 데 동의합니다.
참고 자료
이 문서는 페이스북의 드래프트에 대한 오픈 소스 기여 가이드라인을 바탕으로 작성되었습니다.