시작하기

우리는 깔끔한 프로젝트 이력을 갖는 걸 좋아해. 우리의 커밋 규칙은 Conventional Commits에서 영감을 받았지만, 더 시각적이고 재밌게 만들기 위해 gitmoji로 커스터마이즈했어.

구조

커밋 메시지는 다음과 같이 구조화되어야 해, 그리고 소문자로 작성해야 해:

<gitmoji> <type> <description> [(#<issue number>)]

[optional body]

[optional footer(s)]

예시

📝 update documentation contributors

- Add @jerembdn as a contributor
- Add @younesbessa as a contributor

Co-authored-by: Younes Bessa <[email protected]>

대부분의 경우, 간단한 한 줄이면 충분해:

📝 update documentation contributors

타입

우리는 다음과 같은 커밋 타입을 사용해:

저장소의 첫 번째 커밋은 initial을 사용하고, 버전 태그는 release를 사용해:

🎉 initial commit
🔖 release @onruntime/translations v0.3.0

설명

<type>은 주어의 동사이고, 설명이 그것을 완성해. 함께 읽으면 한 문장이 돼:

# 좋은 예
📝 update documentation contributors

그래서 설명을 두 번째 동사로 열지 마. 타입이 이미 하나 있고, 주어가 두 문장을 쌓이게 만드는 게 fix: 접두사로 이어져. 동사를 빼고 그것이 작용한 것을 유지해:

# 나쁜 예
💄 improve scale down the gem on its card
🐛 fix stop the footer from wrapping

# 좋은 예
💄 improve the gem size on its card
🐛 fix the footer wrapping

명령형과 소문자로 작성해:

# 나쁜 예
📝 updated documentation contributors

# 나쁜 예
📝 Update documentation contributors

이슈 번호

이슈 번호를 추가해 커밋을 이슈에 연결해:

📝 update documentation contributors (#123)

본문

상황과 동기를 위해 본문을 사용해:

📝 update documentation contributors

- Add @jerembdn as a contributor
- Add @younesbessa as a contributor

Co-authored-by: Younes Bessa <[email protected]>