mirror of
https://github.com/gryf/wmaker.git
synced 2026-01-04 21:04:18 +01:00
doc: add a few more suggestions for people willing to contribute
Recommend usage for the configure flag 'enable-debug' when testing code and invite to make use the the checkpatch.pl script. Signed-off-by: Christophe CURIS <christophe.curis@free.fr>
This commit is contained in:
committed by
Carlos R. Mafra
parent
765814e393
commit
029846dd14
@@ -19,6 +19,19 @@ want to switch to #next branch, if not already done:
|
||||
|
||||
git checkout next
|
||||
|
||||
____________________
|
||||
Testing your changes
|
||||
--------------------
|
||||
|
||||
If you want to raise the quality of your contribution, you are strongly
|
||||
encouraged to use at least this configure option:
|
||||
|
||||
./configure --enable-debug
|
||||
|
||||
This does not only enable debugging information, which you may need when
|
||||
testing your work, it also enables a number of extra compiler warning
|
||||
which help keeping safer code.
|
||||
|
||||
__________________________
|
||||
Producing a patch with git
|
||||
--------------------------
|
||||
@@ -49,6 +62,14 @@ git format-patch HEAD~1
|
||||
# after the #next branch, you can use:
|
||||
git format-patch next
|
||||
|
||||
|
||||
In order to ensure consistency in the code, there's an extra step to
|
||||
check the patchs. You should run this script (inherited from the Linux
|
||||
kernel) on the patch files generated and fix your commits for what it
|
||||
reports:
|
||||
|
||||
./checkpatch.pl 00*
|
||||
|
||||
______________________
|
||||
Writing the commit log
|
||||
----------------------
|
||||
|
||||
Reference in New Issue
Block a user