Repository navigation
docs(hr-plain-prose): keep conversation and edit history out of comments, commits and PR text - #546
Merged
Merged
Conversation
…nts, commits and PR text
bompus
added
author:anthropic
![bompus-ai-review[bot]](https://avatars.githubusercontent.com/u/253635?s=60&v=4){kind=small}
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
The code-comment section of
hr-plain-prosenow says not to carry the conversation, the prompt or the edit history into code comments, commit messages or pull request text. It names the usual wording ("changed from", "used to be", "formerly", "as requested") and says to name the real constraint where an old behavior must be kept, instead of writing "preserve the existing behavior".Why
The skill already said a comment must earn its place, and the core rules say docs and comments describe current behavior. Neither names the specific failure of a comment that narrates the editing session ("# used to be x; now y"), and neither covers commit and pull request text. The wording is independently written, informed by the same rule in uv's
AGENTS.md;THIRD_PARTY_NOTICES.mdrecords the source and the one quoted phrase.Checks
bun run check,bun test test/andbun test skills/pass.skills/hr-plain-prose/scripts/check.mjsreports nothing on the new paragraph.The change adds a
CHANGELOG.mdentry under Unreleased.