Contributing
Thanks for stopping by. This is a small project and we'd like to keep it that way — the guiding rule is simple over clever.
How to help
- Found a bug? Open an issue with what you ran, what you expected, and
what happened. The output of
paper run --dry-runis often useful. - Want a feature? Open an issue first so we can agree it's in scope. Small, focused pull requests beat big ones.
- Fixing docs? Typos and unclear sentences are fair game, no issue needed.
Before you open a pull request
- Keep it stdlib-only — no new dependencies without a discussion first.
- Keep CLI logic in
src/, not incmd/paper/main.go. - Run the tests:
go test ./test/... - Rebuild once (
scripts/build.ps1orscripts/build.sh) so you know the embed step still works. - If you changed flags or commands, update the help text in
src/cli.goand the Home docs page to match.
That's it. No commit message police, no templates — just keep it simple and make sure it builds.