git에서 하나의 커밋으로 여러 주석을 형식화하는 좋은 규칙은 무엇입니까

Question

사람들이 일반적으로 단일 커밋에서 여러 주석을 분리하는 방법을 궁금합니다. 별? 쉼표? 별도의 줄? 그냥 당신이 최고가 될만한 것을 궁금해합니다.

Added error messaging 
Cleaned up sign-up UI 
Added recaptcha 

# Please enter the commit message for your changes. Lines starting 
# with '#' will be ignored, and an empty message aborts the commit. 
# 
# Committer: Conrad Chu <chuboy@conradlaptop.local> 
# 
# On branch master 
# Changes to be committed: 
# (use "git reset HEAD <file>..." to unstage) 
# 
#  modified: app/controllers/api_controller.rb 
#  modified: app/controllers/users_controller.rb 
#  modified: app/models/user.rb 
#  modified: app/views/users/new.html.erb 
#  modified: app/views/users/show.html.erb 
#  modified: config/environment.rb 
#  modified: db/migrate/20090923001219_create_users.rb 
#  modified: db/schema.rb 
#  modified: doc/README 
#  modified: public/stylesheets/master.css 
#  new file: vendor/plugins/recaptcha/.gitignore 
#  new file: vendor/plugins/recaptcha/CHANGELOG 

Answer 1

망할 놈의 로그 메시지에 대한 매우 강력한 규칙이 있지만 규칙은 간단합니다 :

내가 이맥스를 통해 의견을 추가 할 때 지금을 사용하지만 확신 나는 그것을 좋아하지

"모듈"
1. 첫 번째 행은 범위 정보 프리픽스를 가질 수
2. 첫번째 줄 커밋을 요약
3. 번째 행은 비어
4. 그런 다음 프리젠 테이션 도구도 (비어있는 두 번째 줄은 중요하고, 많은 그들에 의존으로, 한 당신이이 규칙을 사용합니다 시작으로

할 필요가 같은 문단에서 논의를 다음과 첫 번째 줄 요약 만 볼 수 있습니다.)

git을 사용하면 커밋 수가 작아서 첫 번째 대답은 물론 하나의 커밋으로 많은 내용을 수정해서는 안됩니다. 하나가 아닌 3 개의 커밋이 있어야합니다.

하지만 커밋 로그에 전체 에세이를 작성할 수 있으며 변경 사항 (동기 부여, 폐기 된 디자인, 아이디어)을 모두 설명 할 수 있습니다. 세 가지 변경 사항이 진정으로 함께 있다면,이 텍스트는 그 이유를 분명히 할 것입니다.

동일한 Git Commit 메시지 규칙을 설명하는 more instructions이 있으며 git 명령이 특정 형식에 의존하는 예제가 있습니다. (대부분은 기존의 규칙에 기반을두고 있습니다 : 이메일로 보낸 패치)

Answer 2

여기를보십시오, http://progit.org/book/ch5-2.html, 커밋 가이드 라인과 샘플 커밋이 있습니다.

Answer 3

@ kaizer.se와 (과) 동의해야합니다. git의 기능을 사용하여 수정 사항을 3 가지 다른 커밋으로 스테이지 할 수 있습니다. 이 방법으로 각 수정 사항이 무엇인지 명확하게 알 수 있으며 커밋 코멘트가 그 이유를 알려줍니다. 메인 모드로 병합 할 때 (feature mods를위한 브랜치를 사용한다고 가정 할 때)이 작은 커밋을 하나의 병합으로 롤업 할 수 있습니다.

Answer 4

내가 너무 많은 설명을 필요로 변경 사항을 적용하지 않도록 노력하고 있지만, 필요가 있다면 나는 보통 같은 것을 할 :

Multiple changes: 

- done this 
- fixed that 
- removed other 

Maybe some additional explanations. 

시도를 커밋 원자를 유지하기 위해 지금까지의 기능에 관한 한 . 모든 완성 된 기능을 실제로 커밋하는 것을 잊어 버렸을 때 나는 코드 또는 hunks 코드를 무대에 올립니다.