ARCHIVE/xahaud
3
0
Fork 0
mirror of https://github.com/Xahau/xahaud.git synced 2025-12-06 17:27:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add a summary of the git commit message rules (#5283)

Browse Source
This commit is contained in:
Ed Hennis
2025-02-11 15:50:51 -05:00
committed by tequ
parent cbd7d5dc3a
commit 63665a6673
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@@ -95,6 +95,19 @@ Refer to
["How to Write a Git Commit Message"](https://cbea.ms/git-commit/) ["How to Write a Git Commit Message"](https://cbea.ms/git-commit/)
for general rules on writing a good commit message. for general rules on writing a good commit message.
tl;dr
> 1. Separate subject from body with a blank line.
> 2. Limit the subject line to 50 characters.
> * [...]shoot for 50 characters, but consider 72 the hard limit.
> 3. Capitalize the subject line.
> 4. Do not end the subject line with a period.
> 5. Use the imperative mood in the subject line.
> * A properly formed Git commit subject line should always be able
> to complete the following sentence: "If applied, this commit will
> _your subject line here_".
> 6. Wrap the body at 72 characters.
> 7. Use the body to explain what and why vs. how.
In addition to those guidelines, please add one of the following In addition to those guidelines, please add one of the following
prefixes to the subject line if appropriate. prefixes to the subject line if appropriate.
* `fix:` - The primary purpose is to fix an existing bug. * `fix:` - The primary purpose is to fix an existing bug.