Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 1.25 KB

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 organelle_segmenter_plugin for local development.

  1. Fork the organelle_segmenter_plugin repo on GitHub.

  2. Clone your fork locally:

    git clone git@github.com:{your_name_here}/organelle_segmenter_plugin.git
  3. Install the project in editable mode. (It is also recommended to work in a virtualenv or anaconda environment):

    cd organelle_segmenter_plugin/
    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:

    make build
  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