Update CONTRIBUTING.md

This commit is contained in:
Julian Hofer 2019-04-05 12:31:40 +00:00 committed by Jordan Petridis
parent 80d3bc84b8
commit 990ab29200

View File

@ -47,7 +47,7 @@ cargo test -- --test-threads=1 && cargo fmt --all -- --check
Running the tests requires an internet connection and it it will download some files from the [Internet Archive](archive.org)
The test suite sets a temporary sqlite database in the `/tmp` folder.
Due to that it's not possible to run them in parrallel.
Due to that it's not possible to run them in parallel.
In order to run the test suite use the following: `cargo test -- --test-threads=1`
@ -100,7 +100,7 @@ Steps to reproduce:
2. Ensure the test suit passes. Run `cargo test -- --test-threads=1`.
3. Ensure your code is properly formated. Run `cargo fmt --all`.
4. If you're adding new API, it must be properly documented.
5. The commit message is formatted as follows:
5. The commit message has to be formatted as follows:
```
component: <summary>
@ -110,7 +110,7 @@ Steps to reproduce:
<link to the bug ticket>
```
6. You may merge the pull request in once you have the sign-off of the maintainers, or if you
6. You may merge the pull request once you have the sign-off of the maintainers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.
## Code of Conduct