|
| 1 | +# Contributing |
| 2 | + |
| 3 | +## Issues and bugs :bug: |
| 4 | + |
| 5 | +The easiest way to contribute is to report issues or bugs that you might |
| 6 | +find while using `template-data-package`. You can do this by creating a |
| 7 | +[new](https://github.com/seedcase-project/template-data-package/issues/new/choose) |
| 8 | +issue on our GitHub repository. |
| 9 | + |
| 10 | +## Adding or modifying content :pencil2: |
| 11 | + |
| 12 | +If you would like to contribute content, please check out our |
| 13 | +[guidebook](https://guidebook.seedcase-project.org/) for more specific |
| 14 | +details on how we work and develop. It is a regularly evolving document, |
| 15 | +so is at various states of completion. |
| 16 | + |
| 17 | +To contribute to `template-data-package`, you first need to install |
| 18 | +[uv](https://docs.astral.sh/uv/) and |
| 19 | +[justfile](https://just.systems/man/en/packages.html). We use uv and |
| 20 | +justfile to manage our project, such as to run checks and test the |
| 21 | +template. Both the uv and justfile websites have a more detailed guide |
| 22 | +on using uv, but below are some simple instructions to get you started. |
| 23 | + |
| 24 | +To install uv and justfile, run: |
| 25 | + |
| 26 | +``` bash |
| 27 | +pipx install uv rust-just |
| 28 | +``` |
| 29 | + |
| 30 | +We keep all our development workflows in the `justfile`, so you can |
| 31 | +explore it to see what commands are available. To see a list of commands |
| 32 | +available, run: |
| 33 | + |
| 34 | +``` bash |
| 35 | +just |
| 36 | +``` |
| 37 | + |
| 38 | +As you contribute, make sure your changes will pass our tests by opening |
| 39 | +a terminal so that the working directory is the root of this project |
| 40 | +(`template-data-package/`) and running: |
| 41 | + |
| 42 | +``` bash |
| 43 | +just run-all |
| 44 | +``` |
0 commit comments