Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 1.62 KB

Contributing

Contributions are encouraged, 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 sick-tag-loc-connector for local development.

  1. Fork the sick-tag-loc-connector repo on GitHub.

  2. Clone your fork locally:

    git clone [email protected]:{your_username_here}/sick-tag-loc-connector.git
  3. Install the project in editable mode. (It is also recommended to work in a virtualenv environment):

    cd sick-tag-loc-connector
    virtualenv .venv
    source .venv/bin/activate
    pip install -e .
  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 tox:

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

    git add .
    git commit -m "Resolves #xyz. Your detailed description of your changes."
    git push origin {your_development_type}/short-description
  7. Submit a pull request through the GitHub website.

Any contribution that you make to this repository will be under the MIT license, as dictated by that license.