Skip to content

Commit 3398691

Browse files
authored
chore: add changelog rule in AGENTS.md (#438)
More rules/constraints for the `AGENTS.md`, this time for changelog updates. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Strengthens CHANGELOG requirements in `AGENTS.md`. > > - Mandates PR link placeholder in CHANGELOG updates (`([#TODO](https://github.com/MetaMask/accounts/pull/TODO))`) and adds example formats for features/bug fixes > - Expands Documentation Checks with formatting rules (main entries without period; sub-bullets end with a period) > - Updates workflows and Final Verification checklist to reflect the PR link placeholder requirement > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 0d53c39. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
1 parent 59347b0 commit 3398691

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Instructions for AI coding agents working on the MetaMask Accounts Monorepo.
1616
2. **ALWAYS run `yarn lint:fix`** before completing work
1717
3. **ALWAYS colocate tests** with source files (`.test.ts`)
1818
4. **ALWAYS run tests** after making changes: `yarn test`
19-
5. **ALWAYS update CHANGELOGs** when modifying package behavior
19+
5. **ALWAYS update CHANGELOGs** when modifying package behavior - Include PR link with `TODO` placeholder: `([#TODO](https://github.com/MetaMask/accounts/pull/TODO))`
2020
6. **NEVER use `any` type** - Use proper TypeScript types (`@typescript-eslint/no-explicit-any` is enforced)
2121
7. **NEVER modify git config** or run destructive git operations
2222
8. **NEVER commit** unless explicitly requested by user
@@ -194,7 +194,8 @@ yarn lint:fix
194194
yarn build
195195

196196
# 7. Update CHANGELOG.md with your changes
197-
# Add entry under "Unreleased" section
197+
# Add entry under "Unreleased" section with PR link placeholder
198+
# Format: - Add feature description ([#TODO](https://github.com/MetaMask/accounts/pull/TODO))
198199
```
199200

200201
### Workflow: Modifying Existing Code
@@ -243,6 +244,7 @@ yarn test
243244
yarn lint:fix
244245

245246
# 7. Update CHANGELOG.md with bug fix entry
247+
# Format: - Fix bug description ([#TODO](https://github.com/MetaMask/accounts/pull/TODO))
246248
```
247249

248250
### Workflow: Adding a New Package
@@ -879,6 +881,9 @@ IF you created new public APIs:
879881
880882
IF you changed behavior:
881883
→ Update CHANGELOG.md under "Unreleased" section
884+
→ Use format: `- Description ([#TODO](https://github.com/MetaMask/accounts/pull/TODO))`
885+
→ Main entries (with PR links) should NOT end with a period
886+
→ Sub-bullet items (indented with `-`) MUST end with a period
882887
→ Update relevant documentation in README files
883888
884889
IF you added/modified types:
@@ -896,7 +901,7 @@ IF you added/modified types:
896901
✓ Build succeeds: yarn build
897902
✓ No console.log or debug code remains
898903
✓ JSDoc comments on public functions
899-
✓ CHANGELOG.md updated (if applicable)
904+
✓ CHANGELOG.md updated with PR link placeholder (if applicable)
900905
✓ README.md updated (if API changed)
901906
✓ Dependencies properly declared in package.json
902907
✓ No use of `any` type

0 commit comments

Comments
 (0)