Update agents.md
added AI change rules for propagating docs when changes made
This commit is contained in:
parent
02ed3d68ce
commit
1da3f9028b
|
|
@ -21,3 +21,35 @@ in specs folder. Ignore anything with "draft" in the name. Pointy out workflow
|
||||||
# Additional General Requirements
|
# Additional General Requirements
|
||||||
|
|
||||||
Code is created in files. Code is well documented and explains why the code exists, what it does, maintenance tips, gotchas if any.
|
Code is created in files. Code is well documented and explains why the code exists, what it does, maintenance tips, gotchas if any.
|
||||||
|
|
||||||
|
## Change Propagation Rules
|
||||||
|
|
||||||
|
When any of the following are modified:
|
||||||
|
- API responses
|
||||||
|
- data structures
|
||||||
|
- business logic
|
||||||
|
- system behavior
|
||||||
|
|
||||||
|
You must:
|
||||||
|
|
||||||
|
1. Identify all affected layers:
|
||||||
|
- specs
|
||||||
|
- srv
|
||||||
|
- data-ops
|
||||||
|
- tests
|
||||||
|
|
||||||
|
2. Update only the impacted sections, but in audit mode first. Do not edit yet until I review and give command to proceed with updates
|
||||||
|
|
||||||
|
3. Maintain consistency across:
|
||||||
|
- schema definitions
|
||||||
|
- example data
|
||||||
|
- architecture documentation
|
||||||
|
|
||||||
|
4. Add an entry to `specs/decisions.md` if the change alters:
|
||||||
|
- system behavior
|
||||||
|
- data contracts
|
||||||
|
- architectural assumptions
|
||||||
|
|
||||||
|
5. Do not rewrite entire documents unless explicitly instructed
|
||||||
|
|
||||||
|
Consider writing a change audit template md file for above.
|
||||||
Loading…
Reference in New Issue
Block a user