Skip to content

Commit 637784f

Browse files
committed
docs: add agent guidelines for stability, compatibility, and data persistence
1 parent 8a38132 commit 637784f

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

AGENTS.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,22 @@ Guidelines for autonomous contributors working on this repository.
2020
6. **Commit messaging**
2121
- When suggesting or creating commit titles, always follow the [Conventional Commits](https://www.conventionalcommits.org/) format (e.g., `feat: add highlight toggle command`). Include scope when it adds clarity.
2222

23+
7. **Preserve default behavior**
24+
- Never change the extension's current default behavior without a clear, justified reason. Existing users rely on established workflows; breaking them requires explicit approval.
25+
26+
8. **Do not remove or alter unrelated features**
27+
- When implementing a new feature, do not remove existing features or change other parts of the UI that are not directly related to the task at hand. Keep changes isolated to the feature being worked on.
28+
29+
9. **Consider cross-tool compatibility**
30+
- Any change involving external commands (callable by other extensions), the GitHub export, finding severity, or finding difficulty must account for the broader tooling ecosystem. These interfaces are consumed by other tools (e.g., audit reporting pipelines), so changes must maintain compatibility and be coordinated with those dependencies.
31+
32+
10. **Backward compatibility of persisted data**
33+
- The extension saves audit state (findings, annotations, etc.) to files. Any change to serialization formats or data structures must be able to load data saved by previous versions without loss. Never silently drop fields or change schemas without a migration path.
34+
35+
11. **Stability of contributed extension points**
36+
- Command IDs, view IDs, and configuration keys in `package.json` are public API. Renaming or removing them breaks user keybindings, settings, and other extensions that depend on them.
37+
38+
12. **Minimize new dependencies**
39+
- Keep the extension lightweight. Don't add new `node_modules` dependencies without justification; prefer using VS Code's built-in APIs or small self-contained implementations.
40+
2341
Following these rules keeps the repository friendly to both human maintainers and future AI agents. Thanks for contributing!

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

0 commit comments

Comments
 (0)