Skip to content

docs: standardize CONTRIBUTING against repo-standards - #452

Merged
retr0h merged 1 commit into
mainfrom
docs/standardize-contributing
Aug 16, 2026
Merged

docs: standardize CONTRIBUTING against repo-standards#452
retr0h merged 1 commit into
mainfrom
docs/standardize-contributing

Conversation

@retr0h

@retr0h retr0h commented Aug 16, 2026

Copy link
Copy Markdown
Collaborator

Standardizes this repository's CONTRIBUTING.md against the repo-standards capability, 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:

gohai nats-client nats-server orchestrator osapi
Function signatures missing Code style Code style Code standards pointer only
Go patterns under Testing Code style Code style Code standards pointer only
Code standards
Casing Title Case sentence sentence Title Case

A reader comparing two repositories could not tell whether a difference in the document meant a difference in the rule.

Section order, now fixed

Before you start → Prerequisites → Setup → Project structure →
Code style → Code standards → Testing → (repo-specific) →
Before committing → Branching → Commit messages → Submitting a PR → AI usage → FAQ

Anything invented for one repository now sits after Testing.

The shared text is byte-identical

The Code standards body and the Test file conventions list 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.yml enables unused — named in no prose — and configures goimports under formatters:, not among the linters. Five identical copies of a wrong summary of the file beside them. The guide now names .golangci.yml instead.

Verification

just test passes; coverage unchanged.

🤖 Generated with Claude Code

Code standards pointed at the go-code-standards capability instead of
stating the conventions, so a reviewer reading a pull request in a
browser, a contributor offline, and an agent with a single checkout
each saw a link rather than the rules.

States them in full, in the same words as the other four Go
repositories, under the section order repo-standards now fixes. Building
and running moves after Testing, where sections specific to one
repository belong.

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.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@retr0h
retr0h merged commit 74e61cb into main Aug 16, 2026
10 checks passed
@retr0h
retr0h deleted the docs/standardize-contributing branch August 16, 2026 16:49
@codecov

codecov Bot commented Aug 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #452   +/-   ##
=======================================
  Coverage   99.94%   99.94%           
=======================================
  Files         484      484           
  Lines       24935    24935           
=======================================
  Hits        24921    24921           
  Misses         14       14           

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fe98224...eccdca9. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant