Skip to content

Commit 7f00bbb

Browse files
authored
Update AGENTS.md (#23)
1 parent a341916 commit 7f00bbb

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

AGENTS.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -116,14 +116,21 @@ from server-grade hardware to desktops, mobile, and embedded devices.
116116
`## Out of Scope` sections, in that order, so a reader can understand what the
117117
plan is about and what it deliberately excludes without reading the whole
118118
document. If the plan has unresolved design questions, follow those three
119-
sections with an `## Open Questions` section. And add a `## Recommendations`
120-
section before any other content
119+
sections with an `## Open Questions` section. In `## Open Questions`, use
120+
numbered questions and put an indented `Recommendation:` line under each
121+
question. Also add a separate `## Recommendations` section if any before any
122+
other content.
123+
- When asked to check a plan file for consistency or correctness, use a
124+
two-phase workflow: first perform a read-only audit by inspecting the plan,
125+
related code, documentation and project rules, identifying what may need to
126+
change and why while making no edits; then perform a fix pass by patching all
127+
confirmed issues together.
121128
- Do not suppress formatter, linter and checker warnings without asking first.
122129
- Do not remove tests without asking first. Do not cause regressions in existing
123130
tests without asking first.
124131
- When you are creating CMakeLists.txt files for new folders, follow the
125132
existing patterns, structure and naming conventions.
126-
- Do not create common or utility files without asking first.
133+
- Do not create generic common or utility files without asking first.
127134
- Do not add `_internal`, `_private`, `_impl`, or similar suffixes to files,
128135
types, or functions - the directory already carries that signal. Prefer
129136
specific, descriptive filenames (e.g. `client.c`, `request.c`) over generic
@@ -202,8 +209,9 @@ from server-grade hardware to desktops, mobile, and embedded devices.
202209

203210
## References
204211

205-
- [Unity](https://github.com/ThrowTheSwitch/Unity.git) See `tmp/unity` folder
206-
for a local copy of the source and documentation.
212+
- [Unity](https://github.com/ThrowTheSwitch/Unity.git) See
213+
`tmp/third_party/unity` folder for a local copy of the source and
214+
documentation.
207215

208216
## Design Notes
209217

0 commit comments

Comments
 (0)