풀 리퀘스트(Pull-request)는 Snyk의 기여 합의서에 서명한 후에만 업스트림 코드베이스로의 병합이 고려됩니다. 이 합의서는 기여된 코드에 대한 권리를 Snyk에 할당하고, 그 대가로 귀하에게 사용 라이선스를 부여합니다. 풀 리퀘스트를 제출하면 원클릭으로 합의서를 검토하고 서명하라는 메시지가 표시됩니다 (Snyk은 CLA assistant를 사용합니다).
풀 리퀘스트 (Pull requests)
커밋 메시지 (Commit messages)
커밋 메시지는 Angular 스타일의 커밋 형식을 따라야 합니다 (단, 범위(scope)는 제외).
fix: minified scripts being removed
또한 테스트를 포함합니다.
이를 통해 변경 로그(Change log)를 자동으로 올바르게 생성할 수 있습니다.
커밋 유형(Type)은 다음 중 하나여야 합니다.
feat: 새로운 기능
fix: 버그 수정
docs: 문서만 변경
test: 누락된 테스트 추가
chore: 빌드 프로세스 변경 또는 문서 생성과 같은 보조 도구 및 라이브러리 변경
refactor: 버그 수정이나 기능 추가가 아닌 코드 변경
style: 코드의 의미에 영향을 주지 않는 변경 (공백, 포맷팅, 세미콜론 누락 등)
perf: 성능을 개선하는 코드 변경
메이저 업데이트를 출시하려면 본문 시작 부분에 BREAKING CHANGE:를 추가하고 파괴적 변경에 대한 세부 정보를 기재해야 합니다.
코드 표준
npm run lint를 실행하여 코드가 포함된 .eslintrc 구성을 준수하는지 확인하십시오.
풀 리퀘스트 보내기
정말 중요한 이유가 없는 한 새로운 명령줄 옵션 추가는 일반적으로 권장되지 않습니다.
새로 추가된 코드에 대한 테스트를 추가하십시오 (가능한 경우 디렉토리 및 파일 구조를 미러링하도록 노력하십시오).
철자 검사를 하십시오.
모든 테스트가 통과되지 않으면 풀 리퀘스트(PR)에 대한 코드 리뷰가 진행되지 않습니다.
버그를 수정할 때, 먼저 실패하는 테스트를 커밋하여 CircleCI(또는 승인자)가 코드가 실패함을 확인할 수 있도록 하십시오. 해당 커밋이 완료된 후 버그 수정을 커밋하면 Snyk에서 전후 테스트를 수행할 수 있습니다.
여러 플랫폼과 Node.js 버전용으로 개발하고 있다는 점을 기억하십시오. Mac, Linux 또는 Windows 머신에서 테스트가 통과하더라도 다른 환경에서는 통과하지 못할 수 있습니다.
