docs: 规范 Agent 的小步提交与 PR 边界
This commit is contained in:
@@ -1,5 +1,25 @@
|
||||
# postgresql-tenant-operator - AI Agent Guide
|
||||
|
||||
## Human-Reviewable Changes
|
||||
|
||||
- Break every feature into small, coherent changes that a human can review independently.
|
||||
- Keep each change focused on one behavior or decision; do not mix unrelated refactors,
|
||||
formatting churn, dependency updates, or cleanup into a feature change.
|
||||
- Keep the project buildable and its relevant tests passing after each change whenever
|
||||
practical. Add or update focused tests alongside the behavior they verify.
|
||||
- Present generated files together with the source API or marker change that produced them,
|
||||
and call out generated diffs explicitly instead of treating them as separate design work.
|
||||
- Prefer a sequence of narrow vertical slices over one large implementation. Summarize the
|
||||
intent, observable behavior, and verification for each slice so a human can review it
|
||||
before the next slice grows on top of it.
|
||||
- A pull request may contain multiple small commits. Align each commit with one coherent,
|
||||
independently reviewable change.
|
||||
- When a change reaches a suitable commit boundary, ask the user whether to create the
|
||||
commit before committing it. Do not accumulate unrelated completed changes merely to
|
||||
reduce the number of commits.
|
||||
- Always stop and ask the user before opening or submitting a pull request. Approval to
|
||||
create commits or push a branch does not imply approval to create a pull request.
|
||||
|
||||
## Project Structure
|
||||
|
||||
**Single-group layout (default):**
|
||||
|
||||
Reference in New Issue
Block a user