Skip to content

Commit d0244ea

Browse files
committed
Add guidelines for updating CHANGELOG.md and README.md in AGENTS.md
1 parent 89f6594 commit d0244ea

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,17 @@ src/
104104
- Use `vscode.window.showErrorMessage()` for user-facing errors
105105
- Log to output channel for debugging
106106

107+
### Changelog & README
108+
109+
When adding features, updating features, or fixing bugs:
110+
111+
- **CHANGELOG.md**: Add an entry under the current unreleased version section
112+
- New features → `### Added:`
113+
- Updated features → `### Changed:`
114+
- Bug fixes → `### Fixed:`
115+
- Follow the formatting conventions already in the file
116+
- **README.md**: Update if adding user-facing features. Do not update for bugs or internal changes.
117+
107118
## Anti-Patterns (Don't Do This)
108119

109120
**Don't hardcode command IDs** - use `Commands.*` from constants

0 commit comments

Comments
 (0)