Repository navigation
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
- errcheck: handle fmt.Fprintln error in commit-normalize RunE - govet: replace deprecated reflect.Ptr alias with reflect.Pointer Nightshift-Task: lint-fix Nightshift-Ref: https://github.com/marcus/nightshift
- cli-reference.md: document commit normalize, busfactor, config get/set/validate, init, daemon start/stop/status, install/uninstall, report, and budget snapshot/history/calibrate flags, verified against the cobra definitions in cmd/nightshift/commands/ - sidebars.js: add troubleshooting to the Reference category (page was unreachable from the docs nav) - cmd/provider-calibration: add missing package doc comment - adding-tasks.md: replace stale '50+' task count with the actual 59 - README.md: add a Guides section linking the docs/guides/ pages Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift
This branch has not been deployed
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
Backfills missing user-facing documentation, verified against the cobra command definitions in
cmd/nightshift/commands/:website/docs/cli-reference.md: document the implemented commands that were missing from the reference —commit normalize(with--check/--file),busfactor,config get/set/validate,init,daemon start/stop/status,install/uninstall,report, plus flag tables fortask list/show/runand thebudget snapshot/history/calibratesubcommands. Also corrected the Global Flags section: only--verboseis a root persistent flag;--provider/--timeoutare per-command.website/sidebars.js: addtroubleshootingto the Reference category — the page existed but was unreachable from the docs nav.cmd/provider-calibration/main.go: add the missing package-level doc comment (last package incmd//internal/without one).docs/guides/adding-tasks.md: replace the stale "50+" task count with the actual 59 registered task types.README.md: add a Guides section linking thedocs/guides/pages, which were unreachable from any index.Task counts in
task-reference.md/tasks.mdwere audited against the registry ininternal/tasks/tasks.go(59 entries; cost tiers 5/39/13/2 and risk levels 44/13/2 all match) — no changes needed there.Verification
go build ./...andgo vet ./...passgo test ./cmd/... ./internal/tasks/passeswebsite/docs/*.md— no orphaned pages, no dangling referencesNightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift
Automated by nightshift