Skip to content

Commit 382a18c

Browse files
committed
docs: spelling
1 parent 86b2d6c commit 382a18c

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

CONTRIBUTING.md

+13-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Contributing to mplhep
22

3-
We are happy to accept contributions to `mplhep` via Pull Requests to the GitHub repo. To get started fork the repo.
3+
We are happy to accept contributions to `mplhep` via Pull Requests to the GitHub
4+
repo. To get started fork the repo.
45

56
## Bug Reports
67

@@ -35,23 +36,29 @@ You can run the unit tests (which should be fast!) via the following command.
3536
pytest --mpl --ignore=tests/test_notebooks.py
3637
```
3738

38-
Note: This ignores the notebook tests (which are run via [papermill](https://github.com/nteract/papermill) and run somewhat slow.
39-
Make sure to run the complete suite before submitting a PR
39+
Note: This ignores the notebook tests (which are run via
40+
[papermill](https://github.com/nteract/papermill) and run somewhat slow. Make
41+
sure to run the complete suite before submitting a PR
4042

4143
```bash
4244
pytest --mpl
4345
```
4446

4547
### Making a pull request
4648

47-
We follow [Conventional Commit](https://www.conventionalcommits.org/) for commit messages and PR titles. Since we merge PR's using squash commits, it's fine if the final commit messages (proposed in the PR body) follow this convention.
49+
We follow [Conventional Commit](https://www.conventionalcommits.org/) for commit
50+
messages and PR titles. Since we merge PR's using squash commits, it's fine if
51+
the final commit messages (proposed in the PR body) follow this convention.
4852

4953
### Generating Reference Visuals
5054

51-
If you modified expected outcomes of the tests. New baseline visuals can be generated using this command:
55+
If you modified expected outcomes of the tests. New baseline visuals can be
56+
generated using this command:
5257

5358
```bash
5459
pytest --mpl-generate-path=tests/baseline
5560
```
5661

57-
Only include the actually modified baseline images in your PR! Running `git add -a` and the like will sometimes result in including images which are visually identially but not the same bit-wise.
62+
Only include the actually modified baseline images in your PR! Running `git add
63+
-a` and the like will sometimes result in including images which are visually
64+
identically but not the same bit-wise.

0 commit comments

Comments
 (0)