Skip to content

Commit

Permalink
[WIP] Checkpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
ximinez committed Feb 8, 2025
1 parent 02387fd commit c331c3d
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,19 @@ Refer to
["How to Write a Git Commit Message"](https://cbea.ms/git-commit/)
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
prefixes to the subject line if appropriate.
* `fix:` - The primary purpose is to fix an existing bug.
Expand Down

0 comments on commit c331c3d

Please sign in to comment.