Skip to content
revision

Contributing

Issues and pull requests are welcome — bug reports, feature ideas, and documentation fixes all help.

By taking part you agree to the Code of Conduct. Found a vulnerability? Do not open an issue — follow the security policy instead.

Before you start

Section titled “Before you start”

Open an issue first for anything larger than a bug fix. It is much cheaper to agree on an approach in an issue than to unpick a finished branch — especially for changes to the layout or the keymap, where every golden test moves.

Read Architecture to find the right layer for your change.

The gates

Section titled “The gates”
Terminal window
make fmt
make lint
make test

All three must pass before a PR is ready. CI runs the same checks.

make lint needs golangci-lint installed separately.

Conventions

Section titled “Conventions”

Respect the layering. internal/tui may not import internal/svn or internal/app. A guard test enforces it, so a violation shows up as a test failure rather than a review comment.

New UI components follow the existing contract:

  1. A compile-time interface assertion.
  2. A golden test over View().
  3. A teatest harness driving it as a real Bubble Tea program.

Add the component to cmd/gallery too, so it can be previewed in isolation with make run-gallery.

Goldens are regenerated, not hand-edited:

Terminal window
go test ./... -update

Read the resulting diff. An unexpected file in it means the change reached further than intended — that is the signal the golden tests exist to give you.

Keybindings live in one table. Adding a binding means adding it to the help menu, and the ? overlay has no scrolling — its height is its item count, and at 80×24 it is already full. A new row usually means merging two existing ones.

Tests that need svn

Section titled “Tests that need svn”

Some tests drive a real svn binary against a throwaway repository created with svnadmin. They skip automatically when neither is on the PATH. Install Subversion locally if you are changing anything under internal/svn — otherwise you are running with a large part of the suite silently skipped.

Documentation

Section titled “Documentation”

This site lives in site/. Every page has an Edit this page link at the bottom that opens the right source file on GitHub.

If your change affects behaviour a page describes, update the page in the same PR. Prefer adding to the existing page over creating a new one.

Licence

Section titled “Licence”

revision is MIT licensed. Contributions are accepted under the same terms.