docs: writing style for commits, PRs, and comments - #52
Merged
Conversation
Two rules that kept having to be said out loud: no em or en dashes, and no reviewer-facing hedging in a repo with one maintainer. The file leaned on em dashes in twelve places itself, so those are rewritten too. A style rule its own document ignores does not hold.
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
1 participant
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.
Adds a
Writingsection to CLAUDE.md with two rules:CLAUDE.md used em dashes in twelve places itself, so those are rewritten. A style rule its own document ignores won't be followed.
No behavior change, docs only.