44
55The easiest way to contribute is to report issues or bugs that you might find
66while using `{{ github_repo }}`. You can do this by creating a
7- [new](https://github.com/{{ github_repo_spec }}/issues/new/choose)
8- issue on our GitHub repository.
7+ [new](https://github.com/{{ github_repo_spec }}/issues/new/choose) issue on our
8+ GitHub repository.
99
1010## :pencil2: Adding or modifying content
1111
1212{% if for_seedcase -%}
13- If you would like to contribute content, please check out our
14- [guidebook](https://guidebook.seedcase-project.org/) for more specific details
15- on how we work and develop. It is a regularly evolving document, so is at
16- various states of completion.
13+
14+ If you would like to contribute content, please check out
15+ our [guidebook](https://guidebook.seedcase-project.org/) for more specific
16+ details on how we work and develop. It is a regularly evolving document, so is
17+ at various states of completion.
18+
1719{% - endif %}
1820
1921To contribute to `{{ github_repo }}`, you first need to install
@@ -23,10 +25,10 @@ manage our package, such as to run checks and test the package. Both the uv and
2325justfile websites have a more detailed guide on using uv, but below are some
2426simple instructions to get you started.
2527
26- It's easiest to first
27- [install uv](https://docs.astral.sh/uv/getting-started/installation/) and then
28- install justfile and the other tools with uv. Once you've installed uv, install
29- the other tools by running:
28+ It's easiest to first [install
29+ uv](https://docs.astral.sh/uv/getting-started/installation/) and then install
30+ justfile and the other tools with uv. Once you've installed uv, install the
31+ other tools by running:
3032
3133```bash
3234uv tool install rust-just pyrefly ruff
@@ -38,22 +40,22 @@ Code.
3840We keep all our development workflows in the `justfile`, so you can explore it
3941to see what commands are available. To see a list of commands available, run:
4042
41- ``` bash
43+ ```bash
4244just
4345```
4446
4547As you contribute, make sure your changes will pass our tests by opening a
4648terminal so that the working directory is the root of this package's repository
4749and running:
4850
49- ``` bash
51+ ```bash
5052just run-all
5153```
5254
53- When committing changes, please try to follow
54- [Conventional Commits](https://decisions.seedcase-project.org/why-conventional-commits/)
55- as Git messages. Using this convention allows us to be able to automatically
56- create a release based on the commit message by using
55+ When committing changes, please try to follow [Conventional
56+ Commits](https://decisions.seedcase-project.org/why-conventional-commits/) as
57+ Git messages. Using this convention allows us to be able to automatically create
58+ a release based on the commit message by using
5759[Cocogitto](https://decisions.seedcase-project.org/why-semantic-release-with-cocogitto/).
5860If you don't use Conventional Commits when making a commit, we will revise the
5961pull request title to follow that format, as we use squash merges when merging
0 commit comments