|
1 | 1 | # Contributing to mplhep
|
2 | 2 |
|
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. |
4 | 5 |
|
5 | 6 | ## Bug Reports
|
6 | 7 |
|
@@ -35,23 +36,29 @@ You can run the unit tests (which should be fast!) via the following command.
|
35 | 36 | pytest --mpl --ignore=tests/test_notebooks.py
|
36 | 37 | ```
|
37 | 38 |
|
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 |
40 | 42 |
|
41 | 43 | ```bash
|
42 | 44 | pytest --mpl
|
43 | 45 | ```
|
44 | 46 |
|
45 | 47 | ### Making a pull request
|
46 | 48 |
|
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. |
48 | 52 |
|
49 | 53 | ### Generating Reference Visuals
|
50 | 54 |
|
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: |
52 | 57 |
|
53 | 58 | ```bash
|
54 | 59 | pytest --mpl-generate-path=tests/baseline
|
55 | 60 | ```
|
56 | 61 |
|
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