.. highlight:: shell

============
Contributing
============

Contributions are welcome, and they are greatly appreciated! Every
little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions
----------------------

Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/carlsondev/python-switchbot-ble/issues.

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

Fix Bugs
~~~~~~~~

Look through the GitHub issues for bugs. Anything tagged with "bug"
and "help wanted" is open to whoever wants to implement it.

Implement General Features
~~~~~~~~~~~~~~~~~~~~~~~~~~

Look through the GitHub issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.

Implement Additional SwitchBot Devices
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Feel free to examine the documentation and the code to see if there are any gaps that need to be addressed.
Because each of these devices cost money and not everyone will have each device, any additional support is welcome!

Write Documentation
~~~~~~~~~~~~~~~~~~~

python-switchbot-ble could always use more documentation, whether as part of the
official python-switchbot-ble docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at
https://github.com/carlsondev/python-switchbot-ble/issues.

If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
  are welcome :)

Get Started!
------------

Ready to contribute? Here's how to set up ``python-switchbot-ble`` for local development.

You will need `Git <https://git-scm.com>`_, your favorite text editor, and Python of course.

1. Fork the ``python-switchbot-ble`` repo on GitHub.
2. Clone your fork locally::

    $ git clone https://github.com:your_name_here/python-switchbot-ble.git

3. Set up the Python environment::

    $ cd python-switchbot-ble/

4. Create a branch for local development, originating from the ``develop`` branch::

    $ git checkout -b name-of-your-bugfix-or-feature develop

   Now you can make your changes locally.

5. Commit your changes and push your branch to GitHub::

    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature

6. Submit a pull request through the GitHub website.

Pull Request Guidelines
-----------------------

Before you submit a pull request, check that it meets these guidelines:

1. If the pull request adds functionality, the docs should be updated.
2. The pull request should work for Python 3.9+ on at least Linux
3. Squash all your commits on your PR branch, if the commits are not solving
   different problems and you are committing them in the same PR. In that case,
   consider making several PRs instead.