From 029846dd14dbefc56415253f498c3415e90f9fae Mon Sep 17 00:00:00 2001 From: Christophe CURIS Date: Fri, 4 Jul 2014 23:28:49 +0200 Subject: [PATCH] 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 --- The-perfect-Window-Maker-patch.txt | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/The-perfect-Window-Maker-patch.txt b/The-perfect-Window-Maker-patch.txt index 71ad59e4..78f96826 100644 --- a/The-perfect-Window-Maker-patch.txt +++ b/The-perfect-Window-Maker-patch.txt @@ -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 ----------------------