Contributing

How to contribute

Burnless is open source and welcomes contributions of all kinds.

Set up your dev environment

# Clone the repo git clone https://github.com/Custos-com/Burnless.git cd burnless # Install Go 1.24+ brew install go # Install dependencies make setup # Run tests make test # Run linter make lint

Workflow

01

Fork the repo on GitHub

02

Create a branch: git checkout -b fix/your-fix

03

Make your changes and add tests

04

Run make test and make lint — both must pass

05

Open a PR against the dev branch

06

Wait for review — we aim to respond within 48 hours

Good first issues

We have 12 issues labelled good first issue — small, well-defined, under 2 hours each.

Browse good first issues →