Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

49 lines (35 loc) · 1.91 KB
Raw

How to contribute

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.

To give more information about your bug you can append logs from ~/.local/share/qtile/qtile.log or on occasionally events you can capture bugs with xtrace for this have a deeper look on the documentation about capturing an xtrace

Writing code

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

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.

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

  1. Code: Should conform PEP8 and should pass make lint.
  2. Unit tests: Should pass on travis
  3. Documentation: Should get updated if it needed

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

Thanks