docs: state the shared Go rules in the same words - #470
Merged
Conversation
global/documentation asks that a convention binding several repositories be stated in each of them in the same words, because a difference in wording is a difference in rule. The formatting rule had four wordings across five repositories, and two of them said "should be formatted" where the others said "is formatted". CI enforces it, so it is not advice. The exclusion for generated files was stated in four repositories and missing from gohai, which has two such files. nats-client and nats-server referenced [gofumpt] and [golangci-lint] without ever defining them, so both rendered as literal text rather than links. Sections that differ because the repositories differ are left alone: each one's test commands, package paths and branch-name examples, and osapi's Prettier and Docusaurus rules. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013oR5Gt9WPTTdPKdnShdL7L
retr0h
force-pushed
the
docs/dedrift-shared-rules
branch
from
September 3, 2026 01:19
cbc2bb5 to
30b5f61
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #470 +/- ##
=======================================
Coverage 99.94% 99.94%
=======================================
Files 484 484
Lines 22877 22877
=======================================
Hits 22865 22865
Misses 12 12 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.
Compliance with
global/documentation:What was wrong
The formatting rule had four wordings across five repositories, and two of them changed its force:
CI fails the build on it, so "should be" is not accurate. All five now state it the same way.
The generated-files exclusion was in four repositories and missing from gohai, which has two such files. Stated everywhere now.
nats-client and nats-server referenced
[gofumpt]and[golangci-lint]without ever defining them, so both rendered as literal bracketed text instead of links. Definitions added.The markdown formatting sentence had two wordings; it now reads the same in the four repositories that carry it.
What was deliberately left alone
Differences that exist because the repositories differ, not because the wording drifted:
Testing)Branching)httptest.ServerMeasured before and after: 8 of 20 shared sections were identical, now 9. The two closest remaining (
Test doublesat 98%,Testingat 93%) differ only for the reasons above.Verification
just md-fmt-checkpasses.🤖 Generated with Claude Code
https://claude.ai/code/session_013oR5Gt9WPTTdPKdnShdL7L