nixo
/
gri3-wm
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #1822 from acrisci/feature/docs-contributing-formatting 

docs: improve formatting for CONTRIBUTING
This commit is contained in:
Michael Stapelberg 2015-08-02 09:14:00 -07:00
parent cf199143d9 69f7ad91aa
commit 03799dd851
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.md
View File

@ -1,12 +1,12 @@
# i3status/i3lock bugreports/feature requests # Contributing
Note that i3status and i3lock related bugreports and feature requests should be ## i3status/i3lock bug reports and feature requests
filed in the corresponding repositories, i.e. https://github.com/i3/i3status
and https://github.com/i3/i3lock
# 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). 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). 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 4. Please be aware that we cannot support compatibility issues with
@ -15,16 +15,16 @@ and https://github.com/i3/i3lock
experience has shown that often, the software in question is responsible for 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. 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 * 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 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 the `next` branch for developing and sending your pull request.
* Use `clang-format` to format your code. * 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 ## 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 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. * 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.