Skip to content

Commit dee0c0c

Browse files
authored
docs: ✏️ minor text edits to CONTRIBUTING.md (#80)
# Description Just read this and found some minor things I thought could be slightly rewritten. Needs an in-depth review. ## Checklist - [X] Formatted Markdown - [X] Ran `just run-all`
1 parent 689002f commit dee0c0c

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@
55
The easiest way to contribute is to report issues or bugs that you might
66
find while using `check-datapackage`. You can do this by creating a
77
[new](https://github.com/seedcase-project/check-datapackage/issues/new/choose)
8-
issue on our GitHub repository.
8+
issue on the GitHub repository.
99

1010
## Adding or modifying content :pencil2:
1111

1212
If you would like to contribute content, please check out our
1313
[guidebook](https://guidebook.seedcase-project.org/) for more specific
1414
details on how we work and develop. It is a regularly evolving document,
15-
so is at various states of completion.
15+
so it's at various states of completion.
1616

1717
To contribute to `check-datapackage`, you first need to install
1818
[uv](https://docs.astral.sh/uv/) and
1919
[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.
20+
justfile to manage our project, such as to run checks and tests. Both uv
21+
and justfile have documentation with more detailed guides on how to use
22+
them, but below are some simple instructions to get you started.
2323

2424
It's easiest to install uv and justfile using
2525
[pipx](https://pypa.github.io/pipx/), so install that first. Then,
@@ -37,18 +37,18 @@ available, run:
3737
just
3838
```
3939

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's
42-
repository and running:
40+
As you contribute, make sure your changes pass our tests by opening a
41+
terminal with the working directory set to the root of this project's
42+
repository. Then run:
4343

4444
``` bash
4545
just run-all
4646
```
4747

48-
When committing changes, please try to follow [Conventional
48+
When committing changes, please follow the [Conventional
4949
Commits](https://decisions.seedcase-project.org/why-conventional-commits)
50-
as Git messages. Using this convention allows us to be able to
51-
automatically create a release based on the commit message by using
50+
standard for Git messages. Using this convention allows us to be able to
51+
automatically create a release based on the commit message with
5252
[Commitizen](https://decisions.seedcase-project.org/why-semantic-release-with-commitizen).
5353
If you don't use Conventional Commits when making a commit, we will
5454
revise the pull request title to follow that format, as we use [squash

0 commit comments

Comments
 (0)