Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (34 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 1.79 KB

Contribution guide

Contributions are welcome! 😄

Instructions

  1. Fork the repo to your own GitHub account, click the "Fork" button at the top:

image

  1. Clone the repo and install according to the development instructions. Replace the YOUR_ACCOUNT in the repo URL to the fork on your account:
git clone https://github.com/YOUR_ACCOUNT/fastplotlib.git
cd fastplotlib

# install all extras in place
pip install -e ".[notebook,docs,tests]
  1. Checkout the main branch, and then checkout your feature or bug fix branch, and run tests:

Warning Do not commit or add any changes from examples/screenshots or examples/diffs. If you are creating new test examples that generate or change screenshots please post an issue on the repo and we will help you. The screenshots will be generated on github actions servers, which you can then copy into the screenshots dir. :)

cd fastplotlib

git checkout main

# checkout your new branch from main
git checkout -b my-new-feature-branch

# make your changes
# run tests
REGENERATE_SCREENSHOTS=1 pytest -v -k examples

# make some changes, lint with black, and commit
black .

# add only your changed files, not the entire repo, do not add changes to examples/screenshots
git add my_changed_files

# commit changes
git commit -m "my new feature"

# push changes to your fork
git push origin my-new-feature-branch
  1. Finally make a draft PR against the main branch. When you think the PR is ready, mark it for review to trigger tests using our CI pipeline. If you need to make changes, please set the PR to a draft when pushing further commits until it's ready for review scion. We will get back to your with any further suggestions!