Refine AGENTS.md changelog guidance: silence Codex noise and reserve .changed for breaking changes#24275
Open
Kyle-Neale wants to merge 2 commits into
Open
Refine AGENTS.md changelog guidance: silence Codex noise and reserve .changed for breaking changes#24275Kyle-Neale wants to merge 2 commits into
.changed for breaking changes#24275Kyle-Neale wants to merge 2 commits into
Conversation
The Codex code-review bot derives its rules from AGENTS.md and was raising a finding asking for a changelog entry on essentially every non-draft PR. Changelog files are named `<INTEGRATION>/changelog.d/<PR_NUMBER>.<TYPE>`, so they can only be created after the PR number is assigned -- their absence at review time is expected, not a defect, and the requirement is already enforced by the check_changelog job in pr-quick-check.yml. Add a Review Guidelines section instructing the reviewer to skip this finding, without relaxing the changelog requirement for authored code. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Tighten the changelog guidance in AGENTS.md so agents stop tagging non-breaking work as `.changed`. Rewords the `changed` definition to backward-incompatible changes only, and adds a "Choosing .changed" guardrail that instructs pausing to confirm the change is genuinely breaking before using it. Raised by Eric Weaver in #agent-integrations Slack. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Validation ReportAll 21 validations passed. Show details
|
.changed for breaking changes
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Two related refinements to the changelog guidance in the top-level
AGENTS.md:chatgpt-codex-connector[bot]) not to raise a finding for a missing changelog entry.changedentry-type definition to backward-incompatible changes only, and adds a Choosing.changedguardrail that tells agents to pause and confirm a change is genuinely breaking before using.changed.The changelog requirement for authored code is unchanged.
Motivation
Both changes address feedback from Eric Weaver in #agent-integrations Slack.
AGENTS.mdis the single source both Codex and Claude read for changelog behavior, so tightening the guidance here reshapes both agents at once.Codex missing-changelog noise. Codex derives its review rules from
AGENTS.md, so the existing "changelog entries are required" rule makes it post a finding asking for a changelog on essentially every non-draft PR (e.g. this P2 on #24243). That finding is both unavoidable and redundant:<INTEGRATION>/changelog.d/<PR_NUMBER>.<TYPE>, so they can only be created after the PR number is assigned. Our ownAGENTS.mdtells contributors to open the PR first and add the entry afterward, so the entry is legitimately absent when the PR is first reviewed.check_changelogjob in.github/workflows/pr-quick-check.yml.Over-use of
.changed. Thechangedtype was defined as "Breaking changes or significant modifications", and that loose "or significant modifications" phrasing led agents to tag non-breaking work as.changed(which bumps the major version). The definition is now backward-incompatible-only, with an explicit guardrail to stop and reconsider before choosing it.Review checklist (to be filled by reviewers)
qa/requiredif this PR needs QA validation, orqa/skip-qaif it does not. Exactly one of the two is required.backport/<branch-name>label to the PR and it will automatically open a backport PR once this one is merged🤖 Generated with Claude Code