docs: Consolidate style guide into standards/ directory - #2893
Open
jancurn wants to merge 2 commits into
Open
Conversation
CONTRIBUTING.md restated the style guide next to standards/, and the two had already drifted - CONTRIBUTING said highlight UI with #F86606 and no arrows, while standards/content-standards.md said red boxes and arrows. Agents read standards/, so they followed the stale copy. Fold the rules that only lived in CONTRIBUTING.md into standards/ (screenshot restraint, #F86606 highlights, description phrasing, no question-like headings, "check out" over "see"), and point CONTRIBUTING, README, and AGENTS.md at standards/ instead of repeating them. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Dc8BVKTxW221kzxa3BMJoy
Contributor
|
✅ Preview for this PR (commit |
Add a PR template and make it a step in the pull request process, so the rule reaches whoever - or whatever - drafts the description. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Dc8BVKTxW221kzxa3BMJoy
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
3 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.
CONTRIBUTING.mdrestated the style guide next tostandards/, and the two had drifted - CONTRIBUTING said highlight UI with#F86606and no arrows, whilestandards/content-standards.mdstill said red boxes and arrows, and agents readstandards/. The rules that only lived in CONTRIBUTING now live instandards/, and CONTRIBUTING,README.md, andAGENTS.mdlink there instead of repeating them.Also adds a PR template and a PR process step keeping descriptions to one or two sentences.
https://claude.ai/code/session_01Dc8BVKTxW221kzxa3BMJoy