docs(contributing): add CONTRIBUTING.md formalizing repo standards #117

2026-08-22T04:54:08Z

rootiest commented

2026-08-22 04:54:08 +00:00

Summary

Adds CONTRIBUTING.md documenting the branching/PR workflow (including the three-path rule for out-of-scope changes), commit conventions, fish coding standards (file headers, the public-function doc-header format, private-helper convention, colored --help palette), the opinionated-component tagging system, the docs generation pipeline, testing, and the secrets/machine-config placement rule.
Links out to existing docs (README, docs/manual/07-customization.md, the opinionated-components design spec) for topics already documented there, rather than duplicating them.

Test plan

fish tests/run-tests.fish passes (10/10 functional checks, syntax lint clean)
Markdown reviewed manually for accuracy against current repo conventions (function header format, category list, C1–C6 taxonomy, doc-build pipeline)

## Summary - Adds `CONTRIBUTING.md` documenting the branching/PR workflow (including the three-path rule for out-of-scope changes), commit conventions, fish coding standards (file headers, the public-function doc-header format, private-helper convention, colored `--help` palette), the opinionated-component tagging system, the docs generation pipeline, testing, and the secrets/machine-config placement rule. - Links out to existing docs (README, `docs/manual/07-customization.md`, the opinionated-components design spec) for topics already documented there, rather than duplicating them. ## Test plan - [x] `fish tests/run-tests.fish` passes (10/10 functional checks, syntax lint clean) - [x] Markdown reviewed manually for accuracy against current repo conventions (function header format, category list, C1–C6 taxonomy, doc-build pipeline)

rootiest added 1 commit 2026-08-22 04:54:09 +00:00

docs(contributing): add CONTRIBUTING.md formalizing repo standards f4c4922f0e

Documents the branching/PR workflow, commit conventions, fish function
doc-header and colored --help conventions, the docs generation
pipeline, testing, and the secrets/machine-config placement rule, so
these practices live somewhere durable instead of only in commit
history and conversation memory.

rootiest added 1 commit 2026-08-22 04:54:23 +00:00

docs(contributing): clarify fork workflow for outside contributors 62167a439e

The branch-directly-off-main workflow assumes push access to the
repo; contributors without it should fork and PR from there instead.

rootiest reviewed 2026-08-22 04:57:18 +00:00

rootiest left a comment

👍

rootiest added the Kind/Documentation label 2026-08-22 04:57:50 +00:00

rootiest merged commit 057d9913b9 into main

2026-08-22 04:58:07 +00:00

rootiest deleted branch docs/contributing-guide

2026-08-22 04:58:08 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: rootiest/fish-config#117