Skip to content

Commit 04673df

Browse files
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent 4e50f4b commit 04673df

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/contributing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ out to the developers of the dependency before the package is released to a wide
8181
### Testing the correctness of the plots
8282

8383
Many tests will produce plots and check that they are correct by comparing them with a previously saved and serialized version of the same plots. The ground truth images are located in `tests/_images`. Different OS/versions may produce similar but not identical plots (for instance the ticks/padding could vary). To take into account for this please consider the following:
84+
8485
- you should not use locally generated plots as ground truth images, but you should commit images that have been generated by a GitHub Action. The recommended workflow is to go to the ["actions" page for the repo](https://github.com/scverse/spatialdata-plot/actions/workflows/test.yaml), download the artifacts, and upload them as ground truth (after having reviewed them).
8586
- the ground truth images need to be updated when a new test is passing, or when a test starts producing a slightly different (but consistent) plot.
8687
- please never replace the ground truth images without having manually reviewed them.

0 commit comments

Comments
 (0)