Contributing¶

By contributing to Waku, you agree to abide by our code of conduct.

Prerequisites¶

Building¶

You can build Waku with GNU/Make, simply run the following commands:

GoDockerDocs

make build

make build/docker

make build/docs

Testing¶

Running the following will run all tests as well as check for vulnerabilities.

make test

During development, you can also run the following:

GoDocs

This will run the Waku CLI.

go run .

This will start a development server for documentation on http://localhost:8000.

make docs

Creating commits¶

Commit messages should conform to Conventional commits.

We also ask that your code is formatted before committing by running:

make lint
make fmt

Submitting a Pull Request¶

Push your changes to your waku fork and create a Pull Request against the main branch. Please include a clear and concise description of your changes and why they are necessary. Also ensure that your Pull Request title conforms to Conventional commits and that you have incremented version numbers according to SemVer by running:

make bump version=x.x.x

Creating an issue¶

Please ensure that there is no similar issue already open before creating a new one.

If not, you can choose a relevant issue template from the list. Providing as much information as possible will make it easier for us to help resolve your issue.

Financial contributions¶

You can consider sponsoring Waku. See this page for more details.