Update AGENTS.md
7fac79bf1e958f4a23c57c672d7ded009f6e05c7
1 parent
15d4d488
.agents/AGENTS.md
+20 -3
| 1 | 1 | # RULES FOR AGENTS TO FOLLOW |
|
| 2 | 2 | ||
| 3 | + | * Be concise in your answers: when asked a question, give the direct answer. |
|
| 4 | + | Answer like we're in a conversation. Only go beyond the answer if you think |
|
| 5 | + | I'm missing the point or missing something critical. |
|
| 3 | 6 | * If I ask a question (ie. my prompt ends with a ?), never |
|
| 4 | 7 | make modifications to any files or carry out destructive actions. |
|
| 5 | 8 | Just answer the question as accurately as you can. |
|
| 6 | 9 | * Never add documentation and other non-source files to a commit unless |
|
| 7 | 10 | asked to do so. |
| 14 | 17 | production setting. |
|
| 15 | 18 | * Never change API contracts, eg. URLs and response payload |
|
| 16 | 19 | formats without my explicit authorization. |
|
| 17 | 20 | * If I ask you to remove functionality, also remove the tests for it, don't |
|
| 18 | 21 | change the tests to assert lack of functionality. |
|
| 22 | + | * Don't add tests everytime you make a change. Only add tests that pull |
|
| 23 | + | their weight. |
|
| 19 | 24 | * NEVER remove comments when asked to simplify or cleanup code. |
|
| 20 | 25 | * ALWAYS document public types, functions and fields. |
|
| 21 | 26 | * ALWAYS document private types, functions and fields if they aren't obvious. |
|
| 22 | 27 | * NEVER use unicode characters in source code comments, such as m-dashes. |
|
| 23 | 28 | * NEVER make unrelated changes without asking first. |
| 32 | 37 | constraints. |
|
| 33 | 38 | * When writing technical documentation, comments, etc. ALWAYS adhere to |
|
| 34 | 39 | ADS-STE100 Simplified Technical English, unless asked to adhere to another |
|
| 35 | 40 | style explicitly. |
|
| 36 | 41 | * When committing code, ALWAYS sign the commit. |
|
| 37 | - | * If I don't ask to commit changes, leave them dirty. |
|
| 38 | - | * If I ask to commit changes, but not to amend, create a new commit. |
|
| 39 | - | * Only if I ask to amend should you amend. |
|
| 42 | + | * When fixing something introduced in a recent commit or commit made in the |
|
| 43 | + | current session, generally prefer amending the commit that introduced the problem. |
|
| 44 | + | * Never amend unrelated commits when I ask for an amend. Only ever amend the commit |
|
| 45 | + | that introduced the problem. |
|
| 46 | + | ||
| 47 | + | ## WHEN WORKING ON TRUNK (`main` or `master`) |
|
| 48 | + | ||
| 49 | + | * Generally don't commit changes unless I ask you to. Leave them dirty. |
|
| 50 | + | * Generally don't amend commits that have already been pushed, unless I ask you to. |
|
| 51 | + | ||
| 52 | + | ## WHEN WORKING ON A FEATURE OR DEV BRANCH |
|
| 53 | + | ||
| 54 | + | * Generally amend commits when I ask for changes, or create fixup commits |
|
| 55 | + | if we're working on review feedback. |
|
| 56 | + | * Generally try to keep the branch clean with an ideal history and minimal churn. |