Skip to content

Update CONTRIBUTING.md #737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 24, 2025
Merged

Update CONTRIBUTING.md #737

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e92c937
Update CONTRIBUTING.md
kushalkolar Feb 23, 2025
e42a71a
Update CONTRIBUTING.md
kushalkolar Feb 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,11 @@ git checkout -b my_feature_branch
After you have made changes on this branch, add and commit them when you are ready:

```bash
# lint your code
black .
# black format only the source code
black fastplotlib/

# run tests from the repo root dir
WGPU_FORCE_OFFSCREEN=1 pytest tests/
RENDERCANVAS_FORCE_OFFSCREEN=1 pytest tests/

# desktop examples
pytest -v examples
Expand Down Expand Up @@ -195,6 +195,13 @@ The tests will produce slightly different imperceptible (to a human) results on
ground-truth. A small RMSE tolerance has been chosen, `0.025` for most examples. If the output image and
ground-truth image are within that tolerance the test will pass.

If the test image and ground-truth image are above the threshold, the test will fail and a difference image will be located in the follow directory:

```
examples/desktop/diffs
examples/notebooks/diffs
```

Some feature development may require the ground-truth screenshots to be updated. In the event that your changes require
this, please do the following:

Expand Down Expand Up @@ -288,12 +295,12 @@ pip install -e ".[imgui, tests, docs, notebook]"
4) Lint codebase and make sure tests pass

```bash
# lint codebase
black .
# black format only the source code
black fastplotlib/

# run tests
# backend tests
WGPU_FORCE_OFFSCREEN=1 pytest tests/
RENDERCANVAS_FORCE_OFFSCREEN=1 pytest tests/

# desktop examples
pytest -v examples
Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy