bspwm/doc/CONTRIBUTING.md

25 lines
701 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
2012-12-19 12:57:02 +01:00
[1]: http://cm.bell-labs.com/cm/cs/cbook/
[2]: http://www.x.org/releases/X11R7.5/doc/libxcb/tutorial/
[3]: http://git-scm.com/documentation
[4]: http://www.kernel.org/doc/Documentation/CodingStyle
[5]: http://lea.verou.me/2012/01/why-tabs-are-clearly-superior/