A701팀에서 소프트웨어 개발 시 준수해야 하는 코딩 스타일을 정의하고 가이드합니다.
해당 리포지토리는 merge request를 기반으로 관리됩니다.
$ git clone https://lab.ssafy.com/s12-fintech-finance-sub1/S12P21A701
$ cd S12P21A701
# Install packages.
# git checkout -b [NEW_BRANCH]
# (Working...)
$ git commit [...]
$ git push origin [NEW_BRANCH]
# Enroll merge-request!
# in https://lab.ssafy.com/s12-fintech-finance-sub1/S12P21A701
좋은 커밋 메시지는 가독성을 높이고 유지보수에도 도움이 됩니다.
커밋 메시지는 다음의 형태로 작성해주세요.
[#issue] type: Short (50 chars or less) summary of changes
ex. [S12P11A108-1] feat: Summarize changes in around 50 characters or less
- 반드시 영어로 작성하고 50자를 넘기지 말아주세요.
- 첫 글자는 대문자로 작성해주세요.
- 문장의 끝에 마침표를 적지 말아주세요.
- 문장을 동사 원형으로 시작하는 명령문 형태로 작성해주세요. (
Added->Add)
| type | usage |
|---|---|
| feature: | 새로운 기능 추가 |
| fix: | 버그 수정 |
| docs: | 문서 수정 |
| style: | 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우 |
| refactor: | 코드 리팩터링 |
| test: | 테스트 코드, 리팩터링 테스트 코드 추가 |
| chore: | 빌드 업무 수정, 패키지 매니저 수정 |
| revert: | 머지 리퀘스트 롤백 |
| ci: | CI 관련 수정 |
| misc: | 간단한 수정 사항 적용 |