Files
domcyrus--rustnet/.github/pull_request_template.md
Marco Cadetg 309b91ede1 docs: make the changelog-in-same-PR convention consistent (#503)
CONTRIBUTING.md and RELEASE.md both state that user-visible changes go
into the CHANGELOG.md [Unreleased] section in the same PR that makes
them, rather than being reconstructed at release time. Two places did
not carry that:

- The PR template had no changelog item at all, so the checklist a
  contributor actually fills in never mentioned it.
- CONTRIBUTING.zh-CN.md was missing the bullet its English counterpart
  has, so the localized guidelines disagreed with the English ones.

The template wording allows for changes that are not user-visible, which
is the exception CONTRIBUTING.md already implies by scoping the rule to
user-visible changes.
2026-07-29 21:52:57 +02:00

2.2 KiB

Summary

Linked issue

Closes #

Verification

Per CONTRIBUTING.md > Code Quality Requirements, I ran the following locally and they all pass:

  • cargo fmt --all -- --check
  • cargo clippy --all-targets --all-features -- -D warnings
  • cargo test --all-features
  • cargo build --release

Scope

  • One feature or fix per PR (no unrelated cleanups bundled in)
  • No new dependencies, or rationale provided in the summary above
  • No #[allow(clippy::...)] suppressions, or rationale provided (see CONTRIBUTING.md)
  • User-visible changes are added to the ## [Unreleased] section of CHANGELOG.md in this PR, or this change is not user-visible (see CONTRIBUTING.md)

AI-assisted contributions

If you used an AI assistant (Copilot, Claude, ChatGPT, Cursor, etc.) to write any of this code, that is fine, but please confirm:

  • I have read every line I am submitting
  • I ran the verification commands above myself
  • The PR description reflects what the code actually does

Notes for the reviewer