doc/CONTRIBUTING.md

   1 ## Issues
   2
   3 Always provide the following information when submitting an issue:
   4 - Output of `bspwm -v`.
   5 - Content of `bspwmrc`.
   6 - Steps to reproduce the problem.
   7
   8 ## Pull Requests
   9
  10 ### Requirements
  11
  12 You must be comfortable with [C][1], [XCB][2] and [Git][3].
  13
  14 ### Coding Style
  15
  16 I follow the [Linux Coding Style][4] with the following variations:
  17 - [Indent with tabs, align with spaces][5].
  18 - Always use braces when using control structures.
  19
  20 An [EditorConfig][6] is included for convinience.
  21
  22 [1]: https://www.bell-labs.com/usr/dmr/www/cbook/
  23 [2]: https://xcb.freedesktop.org/tutorial/
  24 [3]: http://git-scm.com/documentation
  25 [4]: https://www.kernel.org/doc/Documentation/process/coding-style.rst
  26 [5]: http://lea.verou.me/2012/01/why-tabs-are-clearly-superior/
  27 [6]: https://editorconfig.org
  28
  29 ## Donations
  30
  31 [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RHTYMMB9SHP68)