Skip to content

Contributing

The flow

  1. Pick a task from the roadmap and open an issue (or comment on one) so nobody does it twice.
  2. Make a branch from master, like feat/redis-check or fix/ftp-timeout.
  3. Write the code and the tests and the doc comments.
  4. Run go test -race ./... and golangci-lint run before pushing.
  5. Open a PR. Keep it small, one thing per PR. Fill in the test plan: what to run and what the reviewer should see.
  6. One teammate reviews it by following the test plan. CI must be green before merging.

Keep it simple

If it can be simple, it should be simple. Before adding a library, a config option or an abstraction, ask "do we need this right now?". Usually the answer is no.

Docs

  • Every public function, type and package needs a doc comment. CI checks this.
  • Every file starts with a one-line description of what's in it. The Architecture page shows these next to each file. A test fails if a Go file is missing one, for other files it's optional but nice.
File type How to write the description
Go // Tests the engine: timeouts, panics and sorting. on the first line, then a blank line, then package .... The blank line matters, without it Go treats the comment as the package description. A file that holds the package doc comment doesn't need one.
YAML, shell, .gitignore # What this file does. on the first line (after #!/usr/bin/env bash in scripts)
go.mod // What this file does. on the first line
Markdown, XML <!-- What this file does. --> at the top
- Comments explain why, the code already shows what.
- Keep docs short and plain, like you're explaining it to a teammate. Use commas, not semicolons.
- The API pages on the website are generated from these comments, so you never edit them by hand.
- If you change how something works, update the matching page in docs/ in the same PR.

Commit messages

Short and clear, like add redis-no-auth check or fix ftp check hanging on silent servers.