Contributions are welcome!
Found a bug or want a new feature? Report an issue.
Want to take a stab at making a code change? Pull requests are also welcome!
Before submitting a pull request, make sure to complete the following steps:
- Format the Go code usign gofumpt
- Ensure the tests pass by running
go test ./... - Regenerate the Markdown table of contents in case you changed Markdown files.
Run
npm run generate-toc - Format the Markdown files using prettier. Run
npm run format-docs:write
It is best if your change is covered by tests. If there are none, consider adding new test cases. Do not worry if you do not know how, we can figure it out during the pull request review.
To run npm commands you will need Node installed,
which comes bundled with npm. Run npm install to install the necessary
dependencies before running those npm run ... commands.