Warning

🚧 Sprout is still in active development and evolving quickly, so the documentation and functionality may not work as described and could undergo substantial changes 🚧

Contributing

Issues and bugs 🐛

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

Adding or modifying content ✏️

If you would like to contribute content, please check out our guidebook for more specific details on how we work and develop. It is a regularly evolving document, so is at various states of completion.

To install Sprout to contribute, you first need to install uv and justfile. We use uv and justfile to manage our project, such as to install development dependencies. Both the uv and justfile websites have a more detailed guide on using uv, but below are some simple instructions to get you started.

To install uv, run:

pipx install uv

Then, open a terminal so that the working directory is the root of this project (seedcase-sprout/) and run:

just install-deps

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