Skip to content

Commit 48b2c03

Browse files
Update AGENTS guidance for changelog and commit quality
Changes: - Clarify that CHANGELOG.md should not be updated; GitHub Releases are the source of truth. - Add commit guidance requiring descriptive messages with rationale and alternatives when relevant. Why: - Aligns repository instructions with current release-note process. - Improves commit history quality and review context for future maintenance. Co-authored-by: Chris Zetter <zetter-rpf@users.noreply.github.com>
1 parent ee19af2 commit 48b2c03

1 file changed

Lines changed: 11 additions & 5 deletions

File tree

AGENTS.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ yarn exec cypress run
4444
# or
4545
yarn exec cypress open
4646
```
47-
- `CHANGELOG.md` must be updated for PRs.
47+
- Do not update `CHANGELOG.md`; use GitHub Releases as the source of truth for
48+
release notes.
4849
- Stylelint exists (`yarn stylelint`) but is not enabled in CI.
4950

5051
## Code Style & Conventions
@@ -55,6 +56,11 @@ yarn exec cypress open
5556
`src/assets/stylesheets/InternalStyles.scss` (and external libs in
5657
`ExternalStyles.scss`); avoid `rem`, prefer `em` and `--scale-factor`.
5758

59+
## Git & Commit Guidance
60+
- Write descriptive commit messages that explain why a change was made.
61+
- When applicable, include alternatives considered and why they were not
62+
chosen.
63+
5864
## Security & Safety Guardrails
5965
- Never commit secrets or real credentials; `.env`, `.env.webcomponent`, and their `*.local` variants are gitignored.
6066
- Never commit generated output: `build/`, `coverage/`,
@@ -66,14 +72,14 @@ yarn exec cypress open
6672

6773
## Common Tasks (add feature, add test, refactor, release/deploy if applicable)
6874
- **Add feature:** update `src/` components/hooks/redux and any affected assets;
69-
ensure `CHANGELOG.md` reflects user-visible changes.
75+
do not update `CHANGELOG.md`.
7076
- **Add test:** unit tests live under `src/` as `*.test.js`;
7177
e2e tests live in `cypress/e2e`; run `yarn test` or `yarn exec cypress run`.
7278
- **Refactor:** keep Shadow DOM styling constraints in mind; re-run `yarn lint`
7379
and `yarn test` after moving files or changing imports.
74-
- **Release/deploy:** follow the release steps in `README.md` (update
75-
`CHANGELOG.md`, bump `package.json` version, PR, tag release); deploys are
76-
driven by `.github/workflows/deploy.yml`.
80+
- **Release/deploy:** follow the release steps in `README.md` (bump
81+
`package.json` version, PR, tag release); do not update `CHANGELOG.md`.
82+
Deploys are driven by `.github/workflows/deploy.yml`.
7783

7884
## Further Reading (relative links)
7985
- `README.md`

0 commit comments

Comments
 (0)