Appendix A β€” Contributing

Warning

🚧 This website and documentation is still in very active development and evolving quickly, so content could undergo substantial changes at any time 🚧

There are general contributing guidelines for those working across the different DP-Next projects, which can be found here. This document is specific to the wp1-ros repository.

A.1 Issues and bugs πŸ›

The easiest way to contribute is to report issues or bugs that you might find while using template-data-package. You can do this by creating a new issue on our GitHub repository.

A.2 Adding or modifying content ✏️

If you would like to contribute content, please check out the Seedcase Project’s guidebook for more specific details on how this repository is and will be developed. It is a regularly evolving document, so is at various states of completion.

To contribute to wp1-ros, you first need to install uv and justfile. We use uv and justfile to manage our project, such as to run checks and build things. Both the uv and justfile websites have a more detailed guide on using uv, but below are some simple instructions to get you started by using pipx.

To install uv and justfile, run:

pipx install uv rust-just

We keep all our development workflows in the justfile, so you can explore it to see what commands are available. To see a list of commands available, run:

just

As you contribute, make sure your changes will pass our tests by opening a terminal so that the working directory is the root of this project (wp1-ros/) and running:

just run-all