Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

68 lines (45 loc) · 2.17 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Get Started!

Ready to contribute? Here's how to set up Graph MBO for local development.

  1. Fork the graph-mbo repo on GitHub.

  2. Clone your fork locally:

    git clone [email protected]:{your_name_here}/graph-mbo.git

  3. Install the project in editable mode. (It is also recommended to work in a virtualenv or anaconda environment):

    $ cd graph-mbo/
$ pip install -e .[dev]

  4. Create a branch for local development:

    $ git checkout -b {your_development_type}/short-description

    Ex: feature/read-tiff-files or bugfix/handle-file-not-found

    Now you can make your changes locally.

  5. When you're done making changes, check that your changes pass linting and tests, including testing other Python versions with make:

    $ tox -e lint

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Resolves gh-###. Your detailed description of your changes."
$ git push origin {your_development_type}/short-description

  7. Submit a pull request through the GitHub website.

Deploying

A reminder for the maintainers on how to deploy a release. If you have not already created accounts on test.pypi.org and pypi.org, do that first. Make sure all your changes are committed.

Make sure you have added API tokens for test.pypi.org and pypi.org as secrets called test_pypi_password and pypi_password in your GitHub repository. See the "Saving credentials on GitHub" section of this guide for instructions on this.

Then run:

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

Next, on GitHub, create a release from the version tag you have just created.

This will release a new package version on Git + GitHub and publish to PyPI.