Skip to content

docs(instructions): add explicit instruction not to modify CHANGELOG.md #735

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
samueltardieu merged 2 commits into from
Jan 3, 2026
Merged

docs(instructions): add explicit instruction not to modify CHANGELOG.md #735

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc708fc
Initial plan
Copilot Jan 3, 2026
e34cad0
docs(instructions): add note not to update CHANGELOG.md
Copilot Jan 3, 2026
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
4 changes: 3 additions & 1 deletion .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
- `Cargo.toml` - Project manifest with dependencies, MSRV (rust-version = "1.87.0"), and linting configuration
- `Cargo.lock` - Locked dependency versions
- `README.md` - User-facing documentation
- `CHANGELOG.md` - Version history
- `CHANGELOG.md` - Version history (DO NOT MODIFY - updated automatically during release process)
- `.gitignore` - Ignores: target/, mutants.out*, flamegraph.svg, perf.data*
- `deny.toml` - Configuration for cargo-deny (license and security checks)
- `.pre-commit-config.yaml` - Pre-commit hooks configuration
Expand Down Expand Up @@ -189,6 +189,7 @@
4. **Check MSRV consistency:** `sh tests/check-msrv-consistency.sh` if you modify Cargo.toml or src/lib.rs
5. **Remove trailing spaces:** All files must have trailing whitespace removed (pre-commit checks enforce this)
6. **Unix line terminators:** Unix regular \n terminators must be used
7. **DO NOT modify CHANGELOG.md:** The changelog is updated automatically during the release process and should not be modified in pull requests

### Commit Message Format
This repository uses **conventional commits**. Every commit message must follow this format:
Expand All @@ -209,6 +210,7 @@
4. **Tests must pass in both debug and release modes** on multiple toolchains (stable, beta, nightly, MSRV).
5. **Documentation tests are separate** from regular tests. Always run both `cargo test --tests` and `cargo test --doc`.
6. **Benchmarks are tests too**. Use `--benches` flag when running tests to include benchmark tests.
7. **DO NOT modify CHANGELOG.md** in pull requests. The changelog is updated automatically by the release script (`release.sh`) which generates it from git commit messages.

## Development Workflow

Expand Down
Loading