Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 966 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 966 Bytes
Raw

Contribution guide

Contributions are welcome!

Instructions

  1. Fork the repo to your own GitHub account

  2. Clone the repo and install according to the development instructions. Replace the URL For the repo on nel-lab to the fork on your account: https://github.com/nel-lab/mesmerize-core#for-development

  3. Checkout the master branch, and then checkout your feature or bug fix branch:

cd mesmerize-core
git checkout master
git checkout -b my-new-feature-branch
# make some changes, lint with black, and commit
black .
git add my_changed_files
git commit -m "my new feature"
git push origin my-new-feature-branch
  1. Run tests, make sure they pass
cd mesmerize-core
MESMERIZE_KEEP_TEST_DATA=1 DOWNLOAD_GROUND_TRUTHS=1 pytest -s .
  1. Finally make a PR against the master branch, the PR will also run tests using our CI pipelines to make sure tests pass on all platforms. We will get back to your with any further suggestions!