Skip to content

Commit 7026fee

Browse files
Add initial AGENTS.md file (#105)
1 parent fe3005c commit 7026fee

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Branch & PR Guidelines
2+
3+
### Overview
4+
This repository uses a branch-based development workflow. Please follow the conventions below when working in this project, especially when creating branches, writing PR titles, and generating commits or documentation.
5+
6+
### Branch Naming
7+
Use the following prefixes:
8+
- `feature/<name>` for new features
9+
- `fix/<name>` for bug fixes
10+
- `refactor/<name>` for refactorings
11+
- `docs/<name>` for refactorings
12+
- `test/<name>` for tests
13+
14+
Avoid slashes other than the prefix.
15+
16+
### PR Titles
17+
Format:
18+
`[<type>] <Short summary>`
19+
20+
Allowed types: `feature`, `fix`, `refactor`, `docs`, `test`
21+
22+
Examples:
23+
- `[feature] Add user registration`
24+
- `[bugfix] Fix memory leak in sync module`
25+
26+
### Notes for Agents
27+
- Never propose changes directly on `master`.
28+
- Always create a branch using the proper prefix.
29+
- PR titles must follow the documented format.

0 commit comments

Comments
 (0)