docs: match the shared CONTRIBUTING skeleton - #484
Merged
Merged
Conversation
Every osapi-io repo carries the same CONTRIBUTING sections in the same order, with project-specific material inserted between them. Comparing all five showed a few places where that skeleton had holes. Add File headers, which states the licence header rule this repo already enforces in source but never wrote down. Add Documentation under Code style, moving the markdown paragraph there from Code style's prose so the section exists where every other repo has it. Code style keeps the UI tooling. The Documentation section further down now covers running and building the site, and points at Code style for formatting rather than repeating the commands. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FuKUsHFG1EqZXamffh9M2c
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #484 +/- ##
=======================================
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:
|
The other repositories that share this skeleton end the test conventions with a sentence naming the external test package and the validateFunc callback. OSAPI had no such sentence, though it is the heaviest user of the convention anywhere: 241 of its 407 public test files already carry validateFunc, 524 uses in total. So the rule was invented here and documented everywhere else. State it, and the repositories that copied it stop being the only ones that can point at it. The setter form is deliberately left out. gohai documents SetXFn(fn) func() returning a restore func; OSAPI pairs SetXFn(fn) with a separate ResetXFn(). Writing one sentence over two different shapes would document a convention neither repository follows. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CM5qrNtYQvdKcemkS5YpiP
This was referenced Sep 6, 2026
Test helpers said to expose a symbol through export_test.go and to reset swapped variables in TearDownSubTest, but never named the shape those setters take. There are twenty-one of them, each a SetXFn paired with a ResetXFn, and forty-five of the fifty-one reset calls come from TearDownSubTest exactly as the next bullet asks. gohai documents its own form, which returns a restore func the caller defers. OSAPI's is the pair, so this says the pair rather than borrowing a sentence that would be wrong here. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CM5qrNtYQvdKcemkS5YpiP
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.
All five osapi-io repos carry the same CONTRIBUTING sections in the same order,
with project-specific material inserted between them. I compared them section by
section; the skeleton was already consistent, with a few holes.
This repo
Adds
### File headers, and splits### Documentationout of## Code style's prose so the section sits where every other repo has it. Code stylekeeps the UI tooling; the
## Documentationsection further down now coversrunning and building the site and points back for formatting.
Across the org
## Project structure, +### File headers## Project structure, +### File headers### File headers,### Documentationsplit out of Code style### File headers,just readycomment droppedjust readycomment dropped## FAQaddedAll six now share the same 22-section skeleton in the same order.
🤖 Generated with Claude Code
https://claude.ai/code/session_01FuKUsHFG1EqZXamffh9M2c