docs: stop restating what go-code-standards specifies - #76
Conversation
CONTRIBUTING.md pointed at the go-code-standards capability and then restated it, saying the specification wins where the two disagree. That acknowledges the duplication rather than removing it, and the two drift independently. The restatement was doubled internally as well: Code standards and Testing both described test package layout, suite naming, and table-driven cases. Removed: the multi-line signature rule, test package layout, suite naming, table-driven cases, and the error-wrapping and import-order baseline. Kept the linter set and the note that tests drive a real HTTP server. Satisfies the repo-standards requirement that a fact is stated in exactly one file. 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 #76 +/- ##
=========================================
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:
|
|
Holding this as a draft. Two things surfaced after it was opened:
|
|
Superseded by #77, which standardizes This PR removed the shared conventions and left a pointer to the |
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>
CONTRIBUTING.mdpointed at thego-code-standardscapability and then restated it, closing with "Where the two disagree, the specification wins." That sentence acknowledges the duplication rather than removing it — and the two copies drift independently, which is what therepo-standardsrequirement Each fact is stated once forbids:Removed
The multi-line signature rule, test package layout, suite naming, table-driven cases, and the error-wrapping / early-return / import-order baseline. All are requirements in
go-code-standards.Kept
The golangci-lint set and the note that tests drive a real HTTP server via
httptest.Server— neither is in the capability.Also fixes an internal duplication
## Code standardsand## Testingeach described test package layout, suite naming, and table-driven cases. Same facts, two places, one file.This matches the pattern
osapi's newCONTRIBUTING.mduses (osapi-io/osapi#450), which points without restating.just testpasses, coverage still 100%.Closes the
osapi-orchestratorhalf ofspecify-go-code-standardstask 3.6.🤖 Generated with Claude Code