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/scrool/xled/issues. Fill all sections for issue template.

Fix Bugs

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

Generally project should implement only features described on https://xled-docs.readthedocs.io/ . Make sure you update device features, behavior, endpoints and so on there as well.

Write Documentation

xled could always use more documentation, whether as part of the official xled 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/scrool/xled/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 xled for local development.

  1. Fork the xled repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/xled.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv xled
$ cd xled/
$ pip install -r requirements_dev.txt
$ pre-commit install
$ python setup.py develop

  4. Create a branch for local development:

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

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 xled tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. 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

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

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

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.7, 3.7, 3.8, 3.9, 3.10 and 3.11. Check https://github.com/scrool/xled/actions and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ pytest tests/test_security.py -k test_identity

To verify test against your device first remove existing Cassette, e.g.:

$ rm tests/cassettes/TestControlInterface.test_timer.yaml

and then pass IP address of your device with a flag to record:

$ env XLED_TEST_HOST=192.168.1.123 XLED_TEST_IS_RECORDING=True pytest -v tests/test_control_low.py -k test_timer