Editing The Good Patch

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
-
== Characteristics of a good patch ==
+
== Characteristics of The Good Patch ==
-
A good patch should:
+
A detailed and technical complement to the [[Maemo contribution guidelines]].
-
* be in [[:wikipedia:Diff#Unified_format|unified context format]] (<code>diff -u</code>)
+
-
** alternatively, be generated with <pre>git format-patch</pre>
+
-
* only include related changes
+
-
* not introduce any compile time warnings
+
-
* have test code (if any) separate from the added/changed functionality
+
-
* not add any extra debug printing, unless absolutely necessary
+
-
* match the coding style of the existing source file, for example with regard to indentation and whitespace
+
-
When attaching a patch to a bug at https://bugs.maemo.org/, add the "patch" keyword to the bug report.
+
* The Good Patch should be in unified context format (diff -u).
-
 
+
* The Good Patch should not include any unrelated changes.
-
[[Category:Development]]
+
* The Good Patch should not generate any more compile time warnings than were already there.
 +
* The Good Patch should have test code (if any) separate from the added/changed functionality.
 +
* The Good Patch should not add any extra debug printing unless absolutely necessary.
 +
* The Good Patch should match the Coding Style of the existing source file, e.g. with regard to indentation and whitespaces etc.
 +
* When attaching The Good Patch in bugs.maemo.org, add the "patch" keyword to the bug report.

Learn more about Contributing to the wiki.


Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!


Cancel | Editing help (opens in new window)
Retrieved from "http://wiki.maemo.org/The_Good_Patch"