Skip to content

chore: add changelog rule in AGENTS.md #438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ccharly merged 1 commit into from
Jan 15, 2026
Merged

chore: add changelog rule in AGENTS.md #438

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Instructions for AI coding agents working on the MetaMask Accounts Monorepo.
2. **ALWAYS run `yarn lint:fix`** before completing work
3. **ALWAYS colocate tests** with source files (`.test.ts`)
4. **ALWAYS run tests** after making changes: `yarn test`
5. **ALWAYS update CHANGELOGs** when modifying package behavior
5. **ALWAYS update CHANGELOGs** when modifying package behavior - Include PR link with `TODO` placeholder: `([#TODO](https://github.com/MetaMask/accounts/pull/TODO))`
6. **NEVER use `any` type** - Use proper TypeScript types (`@typescript-eslint/no-explicit-any` is enforced)
7. **NEVER modify git config** or run destructive git operations
8. **NEVER commit** unless explicitly requested by user
Expand Down Expand Up @@ -194,7 +194,8 @@ yarn lint:fix
yarn build

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

### Workflow: Modifying Existing Code
Expand Down Expand Up @@ -243,6 +244,7 @@ yarn test
yarn lint:fix

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

### Workflow: Adding a New Package
Expand Down Expand Up @@ -879,6 +881,9 @@ IF you created new public APIs:

IF you changed behavior:
→ Update CHANGELOG.md under "Unreleased" section
→ Use format: `- Description ([#TODO](https://github.com/MetaMask/accounts/pull/TODO))`
→ Main entries (with PR links) should NOT end with a period
→ Sub-bullet items (indented with `-`) MUST end with a period
→ Update relevant documentation in README files

IF you added/modified types:
Expand All @@ -896,7 +901,7 @@ IF you added/modified types:
✓ Build succeeds: yarn build
✓ No console.log or debug code remains
✓ JSDoc comments on public functions
✓ CHANGELOG.md updated (if applicable)
✓ CHANGELOG.md updated with PR link placeholder (if applicable)
✓ README.md updated (if API changed)
✓ Dependencies properly declared in package.json
✓ No use of `any` type
Expand Down
Loading