MyGO/mygo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(AGENTS.md): clarify and tighten Git workflow instructions

Browse Source
This commit is contained in:
Sunday
2026-07-05 15:34:22 +08:00
parent 17e346836c
commit bfeb4b26e4
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+7 -8
View File
@@ -37,11 +37,11 @@
## Git Version Control
- Do not create a commit unless the user explicitly asks for one.
- Before any commit, verify the work with the required project checks. For code changes, run `go vet ./... && go test ./...`; for docs-only changes, run the most relevant non-mutating checks available.
- DON'T create a commit unless the user explicitly asks for one.
- Before any commit, verify the work with the required project checks. For code changes, run `go vet ./... && go test ./...`; for docs-only changes, run the most relevant non-mutating checks if available.
- Create a commit only when all required checks pass and the current implementation area has no unresolved issues.
- If a known failing check or unresolved issue belongs to another module and is outside the current task, report it clearly before asking for commit approval.
- Before running `git commit`, write the complete commit message first, show it to the user, and ask for explicit approval. Do not commit until the user approves that exact message.
- Before running `git commit`, write the complete commit message first, show it to the user, and ask for explicit approval. DON'T commit until the user approves that exact message.
- Never include `Co-authored-by`, generated-tool signatures, or external attribution trailers unless the user explicitly asks for them.
### Commit Message Format
@@ -49,7 +49,7 @@
Use Conventional Commits:
```text
<type>[optional scope]: <description title>
<type>[optional scope][optional !]: <description title>
<body>
```
@@ -58,17 +58,16 @@ Use Conventional Commits:
- Add `!` after `type` or `scope` when the change contains a breaking API change.
- Keep the title to one concise sentence describing the main change.
- Write the body as bullet points grouped by change category. Each bullet starts with a typed prefix such as `feat:`, `fix:`, `test:`, `docs:`, `refactor:`, or `build:`.
- Use as few as possible bullets.
- Use one blank line between the title and body, and one blank line between body bullets.
- Do not paste full code sentences into the message body; summarize behavior and intent.
- DON'T paste full code sentences into the message body; summarize behavior and intent.
Example:
```text
feat(middleware): add AdminRequired authorization middleware
- feat: AdminRequired gates admin endpoints by checking user IsAdmin flag.
- feat: Placed after AuthRequired; fetches user from repository, returns 403 for non-admins.
- feat: AdminRequired gates admin endpoints by checking user IsAdmin flag. Placed after AuthRequired; fetches user from repository, returns 403 for non-admins.
- fix: soft-deleted users are rejected with 401 since FindByID excludes them.