docs: clarify conventional commit body blank-line rule

This commit is contained in:
2026-07-05 17:18:59 +08:00
parent b988b4b15e
commit fc2b9312fa
+1 -3
View File
@@ -59,7 +59,7 @@ Use Conventional Commits:
- Keep the title to one concise sentence describing the main 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:`. - 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 as few as possible bullets.
- Use one blank line between the title and body, and one blank line between body bullets. - Use one blank line between the title and body.
- DON'T 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: Example:
@@ -68,9 +68,7 @@ Example:
feat(middleware): add AdminRequired authorization middleware feat(middleware): add AdminRequired authorization middleware
- feat: AdminRequired gates admin endpoints by checking user IsAdmin flag. 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. - fix: soft-deleted users are rejected with 401 since FindByID excludes them.
- test: admin passes, non-admin forbidden, soft-deleted admin rejected, missing user ID. - test: admin passes, non-admin forbidden, soft-deleted admin rejected, missing user ID.
``` ```