Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 1.12 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 czi-to-ome-xslt for local development.

  1. Fork the czi-to-ome-xslt repo on GitHub.

  2. Clone your fork locally:

    git clone git@github.com:{your_name_here}/czi-to-ome-xslt.git
  3. Install dependencies:

    pip install -r tests/python-requirements.txt
  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 tests:

    pytest tests/test_transform.py
  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.