Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (25 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 1.14 KB
Raw

Contributing

Every change lands through a pull request — nothing goes directly to main. See the Contribution Workflow for the full process: draft first, the Copilot review loop, then human review.

Making a change

  1. Branch, then edit the relevant page(s) under src/docs/.

  2. If you added or renamed a page, run the index generator:

    pwsh .github/scripts/Update-DocumentationIndex.ps1

  3. Validate links locally before opening a pull request:

    pwsh .github/scripts/Test-DocumentationLink.ps1

  4. Preview the site if you want to see the rendered result:

    pip install -r requirements.txt
cd src
zensical serve

  5. Open the pull request as a draft and follow the Contribution Workflow.

See the README for what this repository is and how it builds, and the Ways of Working for the conventions every pull request follows — issue format, PR format, branching, and review etiquette.