Michael Stapelberg fe5e7b0c81 move CONTRIBUTING.md to .github/ directory

See https://github.com/blog/2111-issue-and-pull-request-templates

2016-02-19 18:41:30 +01:00

Contributing

i3status/i3lock bug reports and feature requests

Note that bug reports and feature requests for related projects should be filed in the corresponding repositories for i3status and i3lock.

Read the debugging instructions.
Make sure you include a link to your logfile in your report (section 3).
Make sure you include the i3 version number in your report (section 1).
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.

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.
Use the next branch for developing and sending your pull request.
Use clang-format to format your code.
Run the testsuite

Find a reproducible bug from the issue tracker. These issues have been reviewed and confirmed by a project contributor.
Find an accepted enhancement from the issue tracker. These have been approved and are ok to start working on.

There's a very good overview of the codebase available to get you started.