DOCent는 참조와 본문 사이의 거리로 인해 학습의 어려움을 겪는 문제를 해결하기 위한 서비스입니다.
다음 코드 스타일을 따릅니다. 스타일 가이드
브랜치 구조는 아래와 같습니다.
├── main
├── release
├── develop
│ ├── fetaure/feature1
│ └── fetaure/feature2
└── hotfix
├── hotfix/hotfix1
└── hotfix/hotfix2
커밋은 다음 형식으로 합니다.
| 타입 | 설명 |
|---|---|
| Feat | 새로운 기능 추가 |
| Fix | 버그 수정 |
| Refactor | 코드 리팩토링 |
| Perf | 성능 개선 |
| Chore | 기타 변경사항 |
| Style | 스타일 수정 (줄 공백 등) |
| Docs | 문서 수정 |
| Test | 테스트 관련 코드 |
[Type] Title
Body
Title 작성 규칙
- 제목은 50자 미만, 첫 글자 대문자 시작
- 과거형이 아닌 명령형으로 작성(ex, Fixed -> Fix)
- 마지막 글자는 마침표 및 특수기호 사용금지
- 개조식 구문으로 작성(간결하고 요점적으로 서술)
- 필요시, 이슈 트래킹 번호 추가 가능 [#이슈 번호]
Body 작성 규칙
- 본문은 선택사항이며, 최대한 상세히 작성
- 내용은 "어떻게" 보단 "무엇을", "왜" 변경했는지 작성
- 각 줄의 길이는 72자 이내로 작성
- 글머리 기호도 사용 가능. 하이픈(-), 별표(*)