Skip to content

Commit 46b0172

Browse files
Add PyCharm Dockerfile instructions to contributing guide
1 parent 04673df commit 46b0172

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
@@ -86,6 +86,7 @@ Many tests will produce plots and check that they are correct by comparing them
8686
- 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.
8787
- please never replace the ground truth images without having manually reviewed them.
8888
- if you run the tests locally in macOS or Windows they will likely fail because the ground truth images are generated using Ubuntu. To overcome this you can use `act`, which will generate a Docker reproducing the environment used in the GitHub Action. After the Docker container is generated you can use it within IDEs to run tests and debug code.
89+
- in the case of PyCharm, it is easier to create a container from a `Dockerfile` instead of using `act`. Please in such case use the `Dockerfile` made availabel in the repository. If you encountering problems with `act` or `docker`, please [get in touch with the developers via Zulip](https://scverse.zulipchat.com/#narrow/channel/443514-spatialdata-dev) and we will help troubleshoot the issue. See also additional details [here](https://github.com/scverse/spatialdata-plot/pull/397).
8990

9091
## Publishing a release
9192

0 commit comments

Comments
 (0)