The Good Patch

From Maemo Wiki
Revision as of 13:49, 4 February 2010 by imported>amigadave (tidy, add category)
Jump to navigationJump to search

Characteristics of a good patch

A good patch should:

  • be in unified context format (diff -u)
  • 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 whitespaces

When attaching a patch to a bug at https://bugs.maemo.org, add the "patch" keyword to the bug report.