Your first contribution
You learned Grit and you want to give back. Docs fixes are the usual first step: they are small, they are easy to check, and they help the next person who reads the page. The full guide is CONTRIBUTING.md in the repo root, and it is aimed at people changing templates. This page is the shorter path for docs fixes.
Fix a docs page
Docs pages live in docs/app/docs, one page.tsx per page. Course lessons live in docs/content/lessons. Shared text such as versions and page metadata lives in docs/config.
Run the site with pnpm dev in docs/, then open the page you changed and check it reads right.
cd docspnpm dev
A good first fix is something you noticed while reading: a stale version, a broken link, a command that does not do what the page says. Fix the page, check it renders, send the pull request.
Three rules for docs changes. First, never use an em dash in anything a reader sees. Use a colon, a comma or a full stop instead, and run python scripts/check-em-dashes.py in docs/ before you send the pull request: it fails on a new em dash. Second, if you add or rename a page, regenerate the search index with python scripts/search-index.py in docs/, or the page is unfindable. Third, run npx next build in docs/ before you send the pull request.
Find a good first issue
Open issues labelled good first issue are the starting list. Pick one that is small and well described: a docs fix, a missing test, a small bug.
Before you start, check the issue is still open and that no open pull request already covers it. If something is wrong and there is no issue, send the fix: fixes need no issue. Anything bigger than a fix starts with an issue first. Questions and ideas go to Discussions, not the issue tracker.
What a good issue report contains
A bug report needs the Grit version (grit version), where it happens, steps to reproduce starting from grit new if you can, what you expected, the actual output or error text, your operating system, and your Go and Node versions. Say that you searched the existing issues and that you are on the latest version.
A feature request needs what you are trying to do, stated as the problem rather than the solution, what you do today instead, however ugly the workaround is, what it would look like, and where it would live. A feature that replaces forty lines everybody writes is an easier decision than one that replaces nothing.
Security problems do not go in an issue. Report them privately, as SECURITY.md says.
Send the fix
One change per pull request. Write the commit message for somebody reading it in two years with no context: what was wrong, and why the fix is the fix. Conventional prefixes apply: feat:, fix:, docs:, refactor:, test:, chore:.
For code changes, go test ./... passes and gofmt -l . is quiet, and every behavioural change needs a test. Do not bump the version or edit the changelog: releases are cut from main by the maintainer.
What merges quickly: docs that correct something wrong, a fix with a test that fails without it, and a bug reproduced in a scratch project.
