Skip to content

Commit 45bb005

Browse files
authored
docs: 📝 expand on CONTRIBUTING guide (#2)
1 parent a200a49 commit 45bb005

File tree

1 file changed

+50
-5
lines changed

1 file changed

+50
-5
lines changed

CONTRIBUTING.md

Lines changed: 50 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,51 @@
1-
# Want to contribute? Great! :tada:
1+
# Contributing
22

3-
Check out the [Contributing
4-
Guide](https://guides.rostools.org/contributing) for more details on how
5-
to contribute. As always, make sure to adhere to the [Code of
6-
Conduct](CODE_OF_CONDUCT.md).
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-workshop`. You can do this by creating a
7+
[new](https://github.com/rostools/template-workshop/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+
[guide](https://guides.rostools.org/contributing) 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-workshop`, 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+
It's easiest to install uv and justfile using
25+
[pipx](https://pypa.github.io/pipx/), so you should install that first.
26+
Then, to install uv and justfile, run:
27+
28+
``` bash
29+
pipx install uv rust-just
30+
```
31+
32+
We keep all our development workflows in the `justfile`, so you can
33+
explore it to see what commands are available. To see a list of commands
34+
available, run:
35+
36+
``` bash
37+
just
38+
```
39+
40+
As you contribute, make sure your changes will pass our tests by opening
41+
a terminal so that the working directory is the root of this project
42+
(`template-workshop/`) and running:
43+
44+
``` bash
45+
just run-all
46+
```
47+
48+
When testing the template, copier can only use content kept in the Git
49+
history. Meaning that if you make changes to the template and try to
50+
test it, it won't be able to test those changes. You have to commit the
51+
changes first in order for copier to use them.

0 commit comments

Comments
 (0)