git.sur5r.net Git - i3/i3/blob - .github/CONTRIBUTING.md

   1 # Contributing
   2
   3 ## i3status/i3lock bug reports and feature requests
   4
   5 Note that bug reports and feature requests for related projects should be filed in the corresponding repositories for [i3status](https://github.com/i3/i3status) and [i3lock](https://github.com/i3/i3lock).
   6
   7 ## i3 bug reports and feature requests
   8
   9 1. Read the [debugging instructions](https://i3wm.org/docs/debugging.html).
  10 2. Make sure you include a link to your logfile in your report (section 3).
  11 3. Make sure you include the i3 version number in your report (section 1).
  12 4. Please be aware that we cannot support compatibility issues with
  13    closed-source software, as digging into compatibility problems without
  14    having access to the source code is too time-consuming. Additionally,
  15    experience has shown that often, the software in question is responsible for
  16    the issue. Please raise an issue with the software in question, not i3.
  17 5. Please note that i3 does not support compositors (e.g. compton). If you
  18    encountered the issue you are about to report while using a compositor,
  19    please try reproducing it without a compositor.
  20
  21 ## Pull requests
  22
  23 * Before sending a pull request for new features, please check with us that the
  24   feature is something we want to see in i3 by opening an issue which has
  25   ”feature request” or ”enhancement” in its title.
  26 * Use the `next` branch for developing and sending your pull request.
  27 * Use `clang-format` to format your code.
  28 * Run the [testsuite](https://i3wm.org/docs/testsuite.html)
  29
  30 ## Finding something to do
  31
  32 * Find a [reproducible bug](https://github.com/i3/i3/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3Areproducible+label%3Abug+) from the issue tracker. These issues have been reviewed and confirmed by a project contributor.
  33 * Find an [accepted enhancement](https://github.com/i3/i3/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3Aaccepted+label%3Aenhancement) from the issue tracker. These have been approved and are ok to start working on.
  34
  35 There's a very good [overview of the codebase](https://i3wm.org/docs/hacking-howto.html) available to get you started.