Skip to content

Commit 5870bb7

Browse files
authored
docs: require workaround comments in AGENTS (#274)
## Summary - add a repository-wide rule to document workaround context in code comments - require comments to explain why the workaround exists, its scope, and removal conditions ## Testing - not run (docs-only change)
1 parent 8c58899 commit 5870bb7

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
- List files in `docs/` before starting each task, and keep `docs/` up-to-date.
66
- After completing each task, update the relevant `AGENTS.md` and `docs/` files in the same change when policies, structure, or contracts changed.
77
- Write all code and comments in English.
8+
- When introducing a workaround, leave sufficient comments that explain why it exists, its scope, and the conditions for removing it.
89
- Prefer enum types over strings whenever possible.
910
- If you modified Rust code, run `cargo test` from the root directory before finishing your task.
1011
- If you modified frontend code, run `pnpm test` from the frontend directory before finishing your task.

0 commit comments

Comments
 (0)