The Good Patch
(Based on Andre Klapper's input) |
|||
| Line 1: | Line 1: | ||
| - | |||
== Characteristics of The Good Patch == | == Characteristics of The Good Patch == | ||
A detailed and technical complement to the [[Maemo contribution guidelines]]. | A detailed and technical complement to the [[Maemo contribution guidelines]]. | ||
| + | * The Good Patch should be in unified context format (diff -u). | ||
| + | * The Good Patch should not include any unrelated changes. | ||
* The Good Patch should not generate any more compile time warnings than were already there. | * The Good Patch should not generate any more compile time warnings than were already there. | ||
| - | * The Good Patch should | + | * 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 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. | * 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. | * When attaching The Good Patch in bugs.maemo.org, add the "patch" keyword to the bug report. | ||
Revision as of 08:33, 26 November 2008
Characteristics of The Good Patch
A detailed and technical complement to the Maemo contribution guidelines.
- The Good Patch should be in unified context format (diff -u).
- The Good Patch should not include any unrelated changes.
- 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.