Remove setting: cancel_birth_rotation

[bspwm.git] / doc / CONTRIBUTING.md

diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md
index 832d707693fb9132b017d8cae4d41c70dca9c1a0..3c2040b0f9d1fe243e124d0eec010cf223219bc0 100644 (file)
--- a/doc/CONTRIBUTING.md
+++ b/doc/CONTRIBUTING.md
@@ -1,42 +1,28 @@
-## Requirements
+## Issues
 
-You must be comfortable with [C][1], [XCB][2] and [Git][3].
-
-## Coding Style
+Always provide the following information when submitting an issue:
+- Output of `bspwm -v`.
+- Content of `bspwmrc`.
+- Steps to reproduce the problem.
 
-I follow the [Linux Coding Style][4].
+## Pull Requests
 
-## Browsing the Code
+### Requirements
 
-If you use `vim`:
-- Hitting *K* will lead you to the manual page of the function under the cursor (works with most `xcb_*` functions), sometimes you'll have to explicitly specify the section of the manual you're interested in with *3K* (e.g.: `open`).
-- Install `ctags` and run `ctags *.{c,h}` in the directory holding the source. Then, hitting *Ctrl-]* will lead you to the definition of the function/variable/structure under the cursor (to go back: *Ctrl-T*).
-- You can run `make` from `vim` with `:make` and then navigate to the next and the previous error with `:cn` and `:cp`.
+You must be comfortable with [C][1], [XCB][2] and [Git][3].
 
-## Debugging
+### Coding Style
 
-To install debug executables:
-```
-make clean debug && make install
-```
+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.
 
-You can attach to a running *bspwm* process with:
-```
-gdb bspwm $(pgrep -x bspwm)
-c
-```
+[1]: https://www.bell-labs.com/usr/dmr/www/cbook/
+[2]: https://xcb.freedesktop.org/tutorial/
+[3]: http://git-scm.com/documentation
+[4]: https://www.kernel.org/doc/Documentation/process/coding-style.rst
+[5]: http://lea.verou.me/2012/01/why-tabs-are-clearly-superior/
 
-Or if you just want to generate a backtrace (saved in `gdb.txt`):
-`
-ulimit -c unlimited
-startx
-sudo systemd-coredumpctl gdb bspwm
-set logging on
-bt full
-q
-`
+## Donations
 
-[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
+[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RHTYMMB9SHP68)