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 inorbit-instock-connector for local development.

Clone your fork locally:

git clone git@github.com:{your_name_here}/inorbit-robot-connectors.git

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

cd inorbit-robot-connectors/instock_connector
virtualenv .venv
source .venv/bin/activate
pip install -r reqirements-dev.txt

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.
When you're done making changes, check that your changes pass linting and tests, including testing other Python versions with tox:
```
tox
```

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

A reminder for the maintainers on how to deploy. Make sure you are on the main branch and have pulled the latest changes.

Setup virtualenv with dev requirements:

cd inorbit-robot-connectors/instock_connector
virtualenv .venv
source .venv/bin/activate
pip install -r requirements.txt -r requirements-dev.txt

Then run bump2version and choose the part of the version to be bumped, and don't forget to push changes and tags:

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

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