Agent rules
6119747504f63aff812751339d20bb04b9ee56f7
1 parent
385f76c3
.agents/AGENTS.md
added
+35 -0
| 1 | + | # RULES FOR AGENTS TO FOLLOW |
|
| 2 | + | ||
| 3 | + | * If I ask a question (ie. my prompt ends with a ?), never |
|
| 4 | + | make modifications to any files or carry out destructive actions. |
|
| 5 | + | Just answer the question as accurately as you can. |
|
| 6 | + | * Never add documentation and other non-source files to a commit unless |
|
| 7 | + | asked to do so. |
|
| 8 | + | * When making changes to a branch or API that hasn't yet been merged into |
|
| 9 | + | trunk, never worry about compatibility or breaking changes. |
|
| 10 | + | * Never frame a change around what was removed when the user asked for a clean |
|
| 11 | + | cutover. State only the supported behavior and the files changed. |
|
| 12 | + | * Always do things the cleanest way possible. No stopgaps, no hacks, |
|
| 13 | + | no workarounds. Only changes that are safe to commit and publish in a |
|
| 14 | + | production setting. |
|
| 15 | + | * Never change API contracts, eg. URLs and response payload |
|
| 16 | + | formats without my explicit authorization. |
|
| 17 | + | * If I ask you to remove functionality, also remove the tests for it, don't |
|
| 18 | + | change the tests to assert lack of functionality. |
|
| 19 | + | * NEVER remove comments when asked to simplify or cleanup code. |
|
| 20 | + | * ALWAYS document public types, functions and fields. |
|
| 21 | + | * ALWAYS document private types, functions and fields if they aren't obvious. |
|
| 22 | + | * NEVER use unicode characters in source code comments, such as m-dashes. |
|
| 23 | + | * NEVER make unrelated changes without asking first. |
|
| 24 | + | * ALWAYS start by explaining how you understand an issue and propose a fix when |
|
| 25 | + | I identify something wrong, DO NOT just fix it. |
|
| 26 | + | * When I ask you to fix something that was recently commited to a feature |
|
| 27 | + | branch, ALWAYS amend the commit that introduced the bad code. |
|
| 28 | + | * NEVER write comments that narrate a migration, compare against previous |
|
| 29 | + | behavior, defend a design choice, mention rejected alternatives, explain what |
|
| 30 | + | the code does not do, or reference plan/review history. Comments should |
|
| 31 | + | describe only the current code’s stable purpose, invariants, or non-obvious |
|
| 32 | + | constraints. |
|
| 33 | + | * When writing technical documentation, comments, etc. ALWAYS adhere to |
|
| 34 | + | ADS-STE100 Simplified Technical English, unless asked to adhere to another |
|
| 35 | + | style explicitly. |
.codex/AGENTS.md
added
+1 -0
| 1 | + | ../.agents/AGENTS.md |