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

Clone your fork locally:

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

If adding a new connector (yay!), create a directory for it under the repo root using <vendor_connector> or <vendor_model_connector>. Add your new connector's code to it.

If updating an existing connector (thanks!), change directory to the connector you'd like to update.

It is recommended to work in a virtualenv or anaconda environment:
```
cd inorbit-robot-connectors/src/<name_connector>
virtualenv venv
. venv/bin/activate
pip install -r requirements.txt
```
Create a branch for local development:
```
git checkout -b {your_development_type}/short-description
```
Ex: feature/mybot-connector or bugfix/otto-report-errors
Now you can make your changes locally.
When you're done making changes, check that your changes pass linting with pre-commit:

Install pre-commit in your computer and then set it up by running pre-commit install at the root of the cloned project.

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

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