snyk-api-import에 기여하기

기여자 협약

기여한 코드의 권리를 Snyk에 양도하고 귀하는 사용 라이선스를 제공받을 수 있는 기여자 협약에 서명한 후에만 풀 리퀘스트는 상류 코드베이스에 병합될 것입니다. 풀 리퀘스트를 제출하면 클릭 한 번으로 협약을 검토하고 서명하도록 유도됩니다 (Snyk은 CLA assistant를 사용합니다).

풀 리퀘스트

커밋 메시지

커밋 메시지는 Angular 스타일 커밋 형식을 따라야 합니다 (단, 범위를 제외한):

fix: minified scripts being removed

Also includes tests

이렇게 하면 자동으로 변경 로그가 올바르게 생성됩니다.

커밋 유형은 다음 중 하나여야 합니다:

• feat: 새로운 기능

• fix: 버그 수정

• docs: 문서 변경만

• test: 누락된 테스트 추가

• chore: 빌드 프로세스 또는 보조 도구 및 라이브러리 변경 (예: 문서 생성)

• refactor: 버그를 수정하거나 기능을 추가하지 않는 코드 변경

• style: 코드의 의미에 영향을 미치지 않는 변경 사항 (화이트 스페이스, 서식, 누락된 세미콜론 등)

• perf: 성능을 향상시키는 코드 변경

주요 업데이트를 릴리스하려면 본문의 시작에 BREAKING CHANGE:를 추가하고 파괴적 변경 사항의 자세한 내용을 포함해야 합니다.

코드 표준

npm run lint를 실행하여 코드가 포함된 .eslintrc 구성을 준수하는지 확인하십시오.

풀 리퀘스트 보내기

• 새로운 명령줄 옵션은 일반적으로 좋은 이유가 없는 한 권장되지 않습니다.

• 추가된 코드에 대한 테스트를 추가하십시오 (가능한 경우 디렉터리 및 파일 구조를 반영하려고 노력하십시오).

• 맞춤법 검사를 실시하십시오.

• 모든 테스트가 통과할 때까지 PR은 코드 검토를 받지 않을 것입니다.

중요: 버그를 수정할 때는 CircleCI(또는 승인자)가 코드가 실패하는 것을 보여줄 수 있도록 실패하는 테스트를 먼저 커밋하십시오. 해당 커밋이 있으면 버그 수정을 커밋하여 Snyk가 이전에 테스트하고 이후에 테스트할 수 있습니다.

여러 플랫폼 및 Node.js 버전으로 개발 중임을 기억하고 테스트가 Mac, Linux 또는 Windows 기계에서 통과한다 해도 다른 곳에서 테스트가 통과하지 않을 수 있습니다.