Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
22 lines (14 loc) · 807 Bytes

CONTRIBUTING.md

File metadata and controls

22 lines (14 loc) · 807 Bytes

Contributing to boring

Thanks for your interest in boring! :) Contributions are welcome, this guide exists to make sure your time is well spent.

Scope

boring aims to be small, focused, and lightweight. It is build to do only one thing (manage and run SSH tunnels) and to do it well. That means the bar for adding new features, config options, and dependencies is intentionally high.

Before opening a PR

  • Bug fixes and small improvements: open a PR directly.
  • Anything that adds a feature, a config option, or a dependency: please open an issue first so we can agree on scope and approach.

Submitting changes

  • Run make test and make sure everything passes.
  • Keep changes formatted (gofmt) and go vet-clean
  • Keep PRs small and focused.

Thanks for your contributions!