X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=CONTRIBUTING.md;h=474355ad90f7a98c5325ce584f0ce871bf4c719b;hb=14a4e0c6f8500b981ed36b3e772c65c3ca35749d;hp=7a5e0c5fda2b947e1db0c2f11c3a4dab67283d3f;hpb=b9cc54f15b23f3f0d5dc1ff066785fc4589faadf;p=i3%2Fi3 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7a5e0c5f..474355ad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,20 +1,32 @@ -# i3status/i3lock bugreports/feature requests +# Contributing -Note that i3status and i3lock related bugreports and feature requests should be -filed in the corresponding repositories, i.e. https://github.com/i3/i3status -and https://github.com/i3/i3lock +## i3status/i3lock bug reports and feature requests -# i3 bugreports/feature requests +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). -1. Read http://i3wm.org/docs/debugging.html +## i3 bug reports and feature requests + +1. Read the [debugging instructions](http://i3wm.org/docs/debugging.html). 2. Make sure you include a link to your logfile in your report (section 3). 3. Make sure you include the i3 version number in your report (section 1). +4. Please be aware that we cannot support compatibility issues with + closed-source software, as digging into compatibility problems without + having access to the source code is too time-consuming. Additionally, + experience has shown that often, the software in question is responsible for + the issue. Please raise an issue with the software in question, not i3. -# Pull requests +## Pull requests * Before sending a pull request for new features, please check with us that the feature is something we want to see in i3 by opening an issue which has - “feature request” or “enhancement” in its title. + ”feature request” or ”enhancement” in its title. * Use the `next` branch for developing and sending your pull request. * Use `clang-format` to format your code. -* Run the testsuite, see http://i3wm.org/docs/testsuite.html +* Run the [testsuite](http://i3wm.org/docs/testsuite.html) + +## Finding something to do + +* 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. +* 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. + +There's a very good [overview of the codebase](http://i3wm.org/docs/hacking-howto.html) available to get you started.