bspwm/doc/CONTRIBUTING.md

32 lines
952 B
Markdown
Raw Normal View History

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