docs: standardize CONTRIBUTING against repo-standards - #77
Merged
Conversation
The five Go repositories stated the same conventions five different ways. Here they were split across Code standards and Testing, which each described test package layout, suite naming, and table-driven cases -- the same facts twice in one file. Applies the section order repo-standards now fixes: Setup, Project structure, Code style, Code standards, Testing, then the operation walkthrough. Package Structure folds into Project structure, and the Title Case headings become sentence case. The linter list is gone. It named goimports as a linter and omitted unused, while .golangci.yml has enabled unused all along and configures goimports as a formatter. Supersedes #76, which removed these conventions rather than standardizing them. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Thank you for contributing to this project! 😊🕹️ |
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #77 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 14 14
Lines 3217 3217
=========================================
Hits 3217 3217 Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
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.
Standardizes this repository's
CONTRIBUTING.mdagainst therepo-standardscapability, which now fixes the middle sections as well as the opening and closing ones (osapi-io/specs#89, osapi-io/specs#90).The problem
The five Go repositories stated the same conventions five different ways:
Function signaturesCode styleCode styleCode standardsGo patternsTestingCode styleCode styleCode standardsCode standardsA reader comparing two repositories could not tell whether a difference in the document meant a difference in the rule.
Section order, now fixed
Anything invented for one repository now sits after
Testing.The shared text is byte-identical
The
Code standardsbody and theTest file conventionslist are the same bytes in all five repositories — verified by hash. A difference in wording now means a difference in rule.The linter list is gone
Every repository listed "errcheck, errname, goimports, govet, prealloc, predeclared, revive, staticcheck". Every
.golangci.ymlenablesunused— named in no prose — and configuresgoimportsunderformatters:, not among the linters. Five identical copies of a wrong summary of the file beside them. The guide now names.golangci.ymlinstead.Verification
just testpasses; coverage unchanged.🤖 Generated with Claude Code