Skip to content

CodeHiker PR 작성 가이드

MrKeeplearning edited this page Jan 7, 2023 · 4 revisions

PR 작성 가이드

1. 제목

[prefix] 앞서 발행한 이슈 제목

1.1. prefix

Commit message convention에 적용하는 타입과 동일하게 사용합니다.

  • build: 빌드 관련 파일 수정 또는 외부 종속성에 영향을 미치는 변경 사항
  • ci: ci 관련 파일에 대한 변경 사항
  • chore
    • production code(프로그램 구현을 담당하는 부분, 사용자가 실제 사용하는 소스 코드)에 영향을 미치지 않는 작업 (e.g., .gitignore)
    • chore가 아닌 다른 타입에 해당되지 않는 경우
  • docs: 문서 변경 사항
  • feat: 어플리케이션이나 라이브러리에 새로운 기능이 추가
  • fix: 어플리케이션에 대한 버그 해결
  • perf: 성능 향상에 도움을 준 코드 변경 사항
  • refactor: bug fix 또는 새로운 기능 추가(feat)에 해당되지 않는 코드 변경 사항
  • style: 코드의 본래 의도에 영향을 미치지 않는 변경 사항(공백, 세미콜론 누락 등)
  • test: 테스트 코드를 추가 또는 기존 테스트 코드 수정

2. 본문

pull_request_template 양식에 맞추어 작성합니다.

## 작업 내용

## 스크린샷

## 주의사항

closes #{issue_number}
Clone this wiki locally