Contributing

Reporting bugs

Perhaps the easiest way to contribute to Qtile is to report any bugs you run into on the GitHub issue tracker.

Useful bug reports are ones that get bugs fixed. A useful bug report normally has two qualities:

  1. Reproducible. If your bug is not reproducible it will never get fixed. You should clearly mention the steps to reproduce the bug. Do not assume or skip any reproducing step. Described the issue, step-by-step, so that it is easy to reproduce and fix.

  2. Specific. Do not write a essay about the problem. Be Specific and to the point. Try to summarize the problem in minimum words yet in effective way. Do not combine multiple problems even they seem to be similar. Write different reports for each problem.

Ensure to include any appropriate log entries from ~/.local/share/qtile/qtile.log and/or ~/.xsession-errors!

Writing code

To get started writing code for Qtile, check out our guide to Hacking on Qtile.

A more detailed page on creating widgets is available here.

Submit a pull request

You’ve done your hacking and are ready to submit your patch to Qtile. Great! Now it’s time to submit a pull request to our issue tracker on GitHub.

Important

Pull requests are not considered complete until they include all of the following:

  • Code that conforms to PEP8.

  • Unit tests that pass locally and in our CI environment (More below).

  • Documentation updates on an as needed basis.

Feel free to add your contribution (no matter how small) to the appropriate place in the CHANGELOG as well!

Unit testing

We must test each unit of code to ensure that new changes to the code do not break existing functionality. The framework we use to test Qtile is pytest. How pytest works is outside of the scope of this documentation, but there are tutorials online that explain how it is used.

Our tests are written inside the test folder at the top level of the repository. Reading through these, you can get a feel for the approach we take to test a given unit. Most of the tests involve an object called manager. This is the test manager (defined in test/helpers.py), which exposes a command client at manager.c that we use to test a Qtile instance running in a separate thread as if we were using a command client from within a running Qtile session.

For any Qtile-specific question on testing, feel free to ask on our issue tracker or on IRC (#qtile on irc.oftc.net).

Running tests locally

This section gives an overview about tox so that you don’t have to search its documentation just to get started. Checks are grouped in so-called environments. Some of them are configured to check that the code works (the usual unit test, e.g. py39, pypy3), others make sure that your code conforms to the style guide (pep8, codestyle, mypy). A third kind of test verifies that the documentation and packaging processes work (docs, docstyle, packaging).

The following examples show how to run tests locally:
  • To run the functional tests, use tox -e py39 (or a different environment). You can specify to only run a specific test file or even a specific test within that file with the following commands:

    tox -e py39 # Run all tests with python 3.9 as the interpreter
    tox -e py39 -- -x test/widgets/test_widgetbox.py  # run a single file
    tox -e py39 -- -x test/widgets/test_widgetbox.py::test_widgetbox_widget
    
  • To run style and building checks, use tox -e docs,packaging,pep8,.... You can use -p auto to run the environments in parallel.

    Important

    The CI is configured to run all the environments. Hence it can be time- consuming to make all the tests pass. As stated above, pull requests that don’t pass the tests are considered incomplete. Don’t forget that this does not only include the functionality, but the style, typing annotations (if necessary) and documentation as well!