Skip to content

Commit 39dc610

Browse files
rebtoorcursoragent
authored andcommitted
[docs] Add Markdown formatting directive for commit messages
Instruct contributors and AI agents to use GitHub-flavored Markdown in commit message bodies (e.g., backtick-wrapped code references). Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: Roberto Alfieri <ralfieri@redhat.com>
1 parent feee484 commit 39dc610

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,8 @@ and the generated Zuul files (`zuul.d/projects.yaml`, `zuul.d/molecule.yaml`).
200200
If changes span multiple roles, use `[multiple]` or `(multiple)`.
201201
For cross-cutting changes use a category: `[ci]`, `[docs]`, `[Feature]`.
202202
- **Body**: Must be longer than 10 characters and describe **why** the change
203-
was made.
203+
was made. Use GitHub-flavored Markdown (e.g., backtick-wrap code references
204+
like \`variable_name\`, \`path/to/file\`, \`function()\`).
204205
- **Sign-off**: Required (`git commit --signoff`). The sign-off certifies a
205206
[DCO](https://developercertificate.org/). AI agents cannot sign off on behalf
206207
of a human -- the committer must add it themselves or amend the commit.

0 commit comments

Comments
 (0)