diff options
| author | Omni Worker <bot@omni.agent> | 2025-11-22 08:01:07 -0500 |
|---|---|---|
| committer | Omni Worker <bot@omni.agent> | 2025-11-22 08:01:07 -0500 |
| commit | 3379ab781c811e9102cce78090f172e4ebcc7815 (patch) | |
| tree | 6420ae5fde1d2ef0ca47301d035924c2d214e2d0 | |
| parent | 6ed114e6e9ef85b4e9619a213e3ab758135d63a7 (diff) | |
Add commit message guidelines to AGENTS.md
Import the 'Git Good' commit message guidelines to ensure consistent,
high-quality commit messages from both human and agent contributors.
This adds a new section to AGENTS.md detailing the seven rules for
commit messages and provides a template. It also adds a .gitmessage
file to automate the template usage.
Amp-Thread-ID:
https://ampcode.com/threads/T-ec034efc-0ef1-43df-8abe-b0cda0f9115b
Co-authored-by: Amp <amp@ampcode.com>
| -rw-r--r-- | .gitmessage | 26 | ||||
| -rw-r--r-- | AGENTS.md | 39 |
2 files changed, 64 insertions, 1 deletions
diff --git a/.gitmessage b/.gitmessage new file mode 100644 index 0000000..1eb44e6 --- /dev/null +++ b/.gitmessage @@ -0,0 +1,26 @@ + +# Summarize change in 50 characters or less +# +# More detailed explanatory text, if necessary. Wrap it to about 72 +# characters or so. In some contexts, the first line is treated as the +# subject of the email and the rest of the text as the body. The +# blank line separating the summary from the body is critical (unless +# you omit the body entirely); various tools like `log`, `shortlog` +# and `rebase` can get confused if you run the two together. +# +# Explain the problem that this commit solves. Focus on why you are +# making this change as opposed to how (the code explains that). +# Are there side effects or other unintuitive consequences of this +# change? Here's the place to explain them. +# +# Further paragraphs come after blank lines. +# +# - Bullet points are okay, too +# +# - Typically a hyphen or asterisk is used for the bullet, preceded +# by a single space, with blank lines in between, but conventions +# vary here +# +# If applied, this commit will... +# Why was this change made? +# Any references to tickets, articles, etc? @@ -671,7 +671,44 @@ Key concepts: git smartlog ``` -**Create a new commit:** +### Commit Messages + +Follow these rules for good commit messages: + +1. **Separate subject from body with a blank line** +2. **Limit the subject line to 50 characters** +3. **Capitalize the subject line** +4. **Do not end the subject line with a period** +5. **Use the imperative mood in the subject line** (e.g., "Fix bug" not "Fixed bug") +6. **Wrap the body at 72 characters** +7. **Use the body to explain what and why vs. how** + +Template: +``` +Summarize change in 50 characters or less + +More detailed explanatory text, if necessary. Wrap it to about 72 +characters or so. In some contexts, the first line is treated as the +subject of the email and the rest of the text as the body. The +blank line separating the summary from the body is critical (unless +you omit the body entirely); various tools like `log`, `shortlog` +and `rebase` can get confused if you run the two together. + +Explain the problem that this commit solves. Focus on why you are +making this change as opposed to how (the code explains that). +Are there side effects or other unintuitive consequences of this +change? Here's the place to explain them. + +Further paragraphs come after blank lines. + + - Bullet points are okay, too + + - Typically a hyphen or asterisk is used for the bullet, preceded + by a single space, with blank lines in between, but conventions + vary here +``` + +### Create a new commit: ```bash # Make your changes git add . |
