Pull request review guidance
When reviewing pull requests in this repository, always check whether docs/ReleaseNotes.md should be updated.
Use the release note policy in CONTRIBUTING.md (“Release Notes”) as the default:
- Release notes are expected for user-visible, significant compiler behavior changes.
- Common examples include new features (language, hardware support, compiler options), important isolated bug fixes, and changes in default behavior.
- Release notes are often not needed for refactors, test-only updates, or infrastructure-only changes unless user-visible behavior changes.
Account for multi-PR efforts:
- If a PR appears to be one part of a larger tracked effort, recognize that a single shared release note may be intentional.
- In those cases, prefer confirming that release note coverage exists (or is planned) across the broader effort, rather than requiring duplicate entries per PR.
How to comment when release notes are missing:
- If a release note is clearly warranted and missing, call it out and point to
docs/ReleaseNotes.md. - If it is not obvious whether one is required, leave only a gentle prompt: “Did you consider adding a release note?”
When to skip a release note comment:
- If the PR already updates
docs/ReleaseNotes.md, do not ask for an additional release note. - If the PR is docs-only, do not leave a release note comment.
- If the PR is a dependency bump (for example, a “Bump ...” PR), do not leave a release note comment.
Comment tone:
- Use a stronger ask when the PR clearly appears to be a user-visible bug fix or feature.
- If release-note coverage may come in a related PR (including a future PR), ask the author to point to that planned coverage.
- If uncertain, prefer the gentle “Did you consider adding a release note?” wording.