Contributing
Running and Debugging
See the user documentation for details on how to build, run, and instrument Zebra.
Bug Reports
Please create an issue on the Zebra issue tracker.
Pull Requests
PRs are welcome for small and large changes, but please don't make large PRs without coordinating with us via the issue tracker or Discord. This helps increase development coordination and makes PRs easier to merge.
Check out the help wanted or good first issue labels if you're looking for a place to get started!
Zebra follows the conventional commits standard for the commits merged to main. Since PRs are squashed before merging to main, the PR titles should follow the conventional commits standard so that the merged commits are conformant.
Coverage Reports
Zebra's CI currently generates coverage reports for every PR with rust's new
source based coverage feature. The coverage reports are generated by the
coverage.yml file.
These reports are then saved as html and zipped up into a github action's
artifact. These artifacts can be accessed on the checks tab of any PR, next
to the "re-run jobs" button on the Coverage (+nightly) CI job's tab
example.
To access a report download and extract the zip artifact then open the top
level index.html.