Running and Debugging

See the user documentation for details on how to build, run, and instrument Zebra.

Bug Reports

File an issue on the issue tracker using the bug report template.

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 RFCs

Significant changes to the Zebra codebase are planned using Zebra RFCs. These allow structured discussion about a proposed change and provide a record of the planned design.

To make a Zebra RFC:

  1. Choose a short feature name like my-feature.

  2. Copy the book/src/dev/rfcs/ file to book/src/dev/rfcs/

  3. Edit the template header to add the feature name and the date, but leave the other fields blank for now.

  4. Write the design! The template has a suggested list of sections that are a useful guide.

  5. Create an design PR using the RFC template.

  6. Take the next available RFC number (not conflicting with any existing RFCs or design PRs) and name the RFC file accordingly, e.g., for number 27. Make sure that book/src/ links to the numbered RFC.

  7. After creating an RFC PR, update the RFC header and the PR description with the PR number.

  8. After the RFC is accepted, create an issue for the implementation of the design, and update the RFC header and PR description with the implementation issue number.