codestates / codestates/BuildUp-client
[Guide] 커밋 메세지 작성 규칙
- Vorherrschende Sprache
- JavaScript
- Sterne
- 0
- Forks
- 1
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
## Fill the title according to the below form
[Client/Server/Database] / [#이슈번호] / edit: [수정한 파일명]
## ISSUE
* Group: client, server, database
* Type: add, fix
* Detail: Commit Message 규칙
## 커밋 메세지 규칙
- [x] 이해하기 쉬운 커밋메세지 작성
- 좋은 커밋 메세지 작성법
- https://blog.ull.im/engineering/2019/03/10/logs-on-git.html //문법
- https://hyeran-story.tistory.com/99 //간단요약
- [x] 명사를 사용, 부정문 Don't 사용 금지
- [x] 명령문으로 작성, 과거형 사용 금지
- [x] 커밋 메세지 구조
```js
[type]() 헤더
[BLANK LINE]
[body] 본문
[BLANK LINE]
[footer] 바닥글
```
- https://beomseok95.tistory.com/328
```js
FEAT: 새로운 기능 추가
FIX: 버그 수정
DOCS: 문서 관련
REFACTOR: 코드 리팩토링
TEST: 테스트 코드
CHORE: 빌드 업무 수정, 패키지 매니저 수정 등
ADD: 기능도 아니고 문서도 아니고 애매한 뭔가를 추가할 때
DELETE: 삭제
UPDATE: 버전 업데이트
RENAME: 이름 변경
MOVE: 코드나 파일 이동
MODIFY: 수정
CORRECT: 문법 오류, 타입 변경, 오타 등
```
- [ ] 상세예시
[동작] #[이슈번호] - [내용]
예시1: Add #11 - edit: login
예시2: Fix #24 - edit: logout
## Estimated time
> Pick one of the below
> 1h
## Labels
Estimated time: E: 1h
Group : client, server
Sprint: Sprint__NUMBER__
Urgency:Low
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Beginne mit Issue #6 und überprüfe die bestehenden Regeln für Commit-Nachrichten, das Format, die Typenliste und die abgehakten Beispiele. Füge anschließend die fehlenden detaillierten Beispiele hinzu, die im nicht abgehakten Punkt angefordert werden, und überprüfe dann, ob die Beispiele der angegebenen Struktur und den Konventionen entsprechen; im Issue wird keine Repository-Datei und kein Test genannt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100