Docs
Everything here describes gitgoblin as designed and as it exists today, with the difference marked. The deeper material lives in the repository and is linked from every page.
- Getting started
- Run the code that exists today, find your way around the repository, and work on the website.
- How it works
- The four stages, the contribution engine's pipeline, and the rules that decide when it continues, retries, asks a human or stops.
- What it finds
- The twelve kinds of opportunity, the evidence behind each, how scores decompose into factors, and how a project's welcomeness is judged.
- Safety and etiquette
- The boundaries enforced in code, what the agent can never do inside a run, and the commitments gitgoblin makes to the projects it touches.
- Status
- What exists today, what is being built, and what is deliberately left for later. Updated as pieces land.
Source of truth
When this site and the repository disagree, the repository wins. The README keeps the status table, architecture.md explains how the packages fit, andetiquette.md is the policy gitgoblin holds itself to in other people's projects.