Skip to content

History / Your First Contribution

Revisions

  • Add Your-First-Contribution.md: a real onboarding path for code contributors Prompted by an LLM council session on tuicc's architecture readability — the council converged (independently across multiple advisors and peer review) on: nobody has ever tested this repo's docs against a human without full session context, and the gap isn't the code architecture itself (praised independently by two advisors and an earlier external review), it's that CLAUDE/NOTES/*.md and the wiki's existing pages serve two different audiences without a clear entry point for either. Getting-Started.md is explicitly "no coding required" (end-user setup). CONTRIBUTING.md has solid PR-review rules but no walkthrough — it assumes you already know your way around the codebase. Nothing filled the actual gap: a first-time code contributor's path from "cloned the repo" to "made one real change and saw it work." New page walks through: a one-minute mental model (Provider abstraction, registry-pattern modules, dataclass+function state convention — pointing to Architecture.md for depth, not duplicating it), then a concrete, zero-invented-scope worked example — uncommenting the already-shipped, already-documented Night Light [[control.toggle]] example from defaults/config.toml, reading it next to Config-Reference.md's contract, running it for real (including deliberately trying it without gammastep installed, to see the project's no-silent-failure principle fire for real instead of just reading about it) — then writing one of your own as practice, explicitly not meant to become a real PR (packaged toggle examples are curated, not "add more" — see VISION.md's own reasoning). Closes with what a genuinely good first real PR looks like (docs fix, small module, new provider) and hands off to CONTRIBUTING.md. Linked from Home.md (right after Getting-Started, as the other kind of "getting started") and from CONTRIBUTING.md's own opening (a pointer before the review rules, for anyone who isn't ready for them yet).

    @Lshika-linux Lshika-linux committed Aug 14, 2026