docs: document dev build/test workflow and provider-calibration - #220
Open
gregggreg wants to merge 5 commits into
Open
docs: document dev build/test workflow and provider-calibration#220gregggreg wants to merge 5 commits into
gregggreg wants to merge 5 commits into
Conversation
Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift
Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift
Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift
Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift
Add a Building and testing subsection to the README Development section covering the Makefile targets, and a package doc comment for cmd/provider-calibration, the only package in the repo without one. Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift
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
2 participants
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.
Documentation backfill. Two gaps found by inventorying the repo's docs against its source, and only what the source verifiably supports was written.
Filled
## Development— the section only covered pre-commit hooks. Added a clone/make depssnippet and a Building and testing subsection documenting theMakefiletargets (build,test,test-race,coverage,lint,check,clean, plusinstall/coverage-html), and a note onmake calibrate-providerslinking to the existing provider calibration guide.cmd/provider-calibration/main.go— added a package doc comment. This was the only package incmd/orinternal/without one. It describes the tool's inputs, its flags, and its output, and points atdocs/guides/provider-calibration.md.Verified
Every command quoted in the new docs was run on this branch before it shipped:
make build,make test,make test-race,make coverage,make lint(0 issues),make deps,make clean,make help,make calibrate-providers, plusgo build ./...andgo vet ./...— all succeeded.Left undocumented, and why
.gofile incmd/andinternal/found zero undocumented exported funcs, methods, types, vars, or consts. Prior backfills covered this.Use:strings incmd/nightshift/commandsare already covered bywebsite/docs/cli-reference.md. No gap.CONTRIBUTING.md— not added. The build/test workflow is the substance a contributing guide would carry, and it now lives in the README next to the pre-commit hook docs; a separate file would duplicate it. Review/PR conventions are not derivable from the source, so inventing them was out of scope.const/varblocks — not swept. Lower value than the two gaps above and not worth the diff noise.Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift