Tell agents to add a CHANGELOG entry for user-facing changes#8483
Merged
fhammerschmidt merged 1 commit intoJun 22, 2026
Merged
Conversation
fhammerschmidt
approved these changes
Jun 22, 2026
rescript
@rescript/darwin-arm64
@rescript/darwin-x64
@rescript/linux-arm64
@rescript/linux-x64
@rescript/runtime
@rescript/win32-x64
commit: |
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
2 participants
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.
AGENTS.md is the entry point for agents working in this repo, but the changelog requirement only lives in CONTRIBUTING.md. An agent that follows AGENTS.md therefore gets no signal that a CHANGELOG.md entry is expected.
This is not hypothetical. On #8482 the code fix was made by following AGENTS.md, the PR was opened, and the changelog entry was missed because nothing in the agent workflow mentioned it. A reviewer had to ask for it after the fact. Adding the step to the AGENTS.md workflow checklist would have caught it up front, which is why this change is needed.