docs: backfill provider-calibration package comment and CLI command reference - #239
Open
iamlasse wants to merge 2 commits into
Open
docs: backfill provider-calibration package comment and CLI command reference#239iamlasse wants to merge 2 commits into
iamlasse wants to merge 2 commits into
Conversation
Add internal/commits with pure Normalize/validate functions enforcing the project's Conventional Commits rules (known type set, lowercase type, lowercase subject, 72-char subject limit, whitespace trimming, and 72-column body wrapping). Wire it into the CLI as 'nightshift commit normalize' (positional, --file, and stdin sources; --check to validate only), ship a commit-msg git hook under scripts/, and document the format and installation in docs/commit-messages.md. Nightshift-Task: commit-normalize Nightshift-Ref: https://github.com/marcus/nightshift
Backfill the two documentation gaps remaining at c26c5fd: a package doc comment for cmd/provider-calibration and a user-facing command reference at docs/guides/commands.md cross-checked against the Cobra command tree. No behavioral changes; Go diff is comment-only. 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
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.
Summary
Documentation backfill for task
docs-backfill. An audit of the tree at c26c5fd found the codebase already well-documented (all internal packages have package comments; 0 exported symbols lack doc comments), so this PR closes the two gaps that remained:cmd/provider-calibration/main.go— the only package in the repo without a// Package ...comment now has one, describing the tool's role and pointing to the provider-calibration guide.docs/guides/commands.md— new user-facing command reference cross-checked against the Cobra command registrations incmd/nightshift/commands/(run, preview, task, budget + snapshot/history/calibrate, busfactor, stats, report, status, logs, setup, init, config, install/uninstall, daemon, doctor, commit). Notes thatsnapshot/history/calibrateare subcommands ofbudget, and links to the deeper guides (run-lifecycle, adding-tasks, agent-tmux-integration, codex-budget-tracking, provider-calibration, commit-messages).Verification
gofmt -lclean,go vet ./...clean,go build ./...OKgo test ./...all packages passNightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift
Automated by nightshift