Skip to content

Commit 70e27cf

Browse files
authored
Add commit and PR guidelines to AGENTS.md
Added guidelines for commit messages and PR titles.
1 parent d08a700 commit 70e27cf

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

AGENTS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,3 +86,8 @@ Before accepting new PRs, we use the latest version of Ruff to lint the code, as
8686
- Always plan first
8787
- Think harder in the planning phase
8888
- When proposing tasks, highlight potential critical points that could lead to side effects.
89+
90+
## Commits and PRs
91+
92+
- Commit messages should follow the semantic commit conventions, and at least, contain one line with the following format: `<type-code>: <message>` where `<type-code>` indicates the type of comment. Type of comments can be fixes and bugfixes (`fix:`), enhancements and new features (`enh:`), style (`sty:`), documentation (`doc:`), maintenance (`mnt:`), etc.
93+
- PR titles should also be semantic, and use the same Type codes but in all caps (e.g., `FIX:`, `ENH:`, `STY:`, `DOC:`, `STY:`, `MNT:`)

0 commit comments

Comments
 (0)