The Good Patch - Revision history

amigadave: add wikipedia link

amigadave — Wed, 02 Feb 2011 13:16:33 GMT

add wikipedia link

← Older revision		Revision as of 13:16, 2 February 2011
Line 1:		Line 1:
	== Characteristics of a good patch ==		== Characteristics of a good patch ==
	A good patch should:		A good patch should:
-	* be in unified context format (<code>diff -u</code>)	+	* be in [[:wikipedia:Diff#Unified_format\|unified context format]] (<code>diff -u</code>)
	** alternatively, be generated with <pre>git format-patch</pre>		** alternatively, be generated with <pre>git format-patch</pre>
	* only include related changes		* only include related changes

amigadave: /* Characteristics of a good patch */ add git format-patch comment

amigadave — Tue, 01 Feb 2011 09:57:01 GMT

Characteristics of a good patch: add git format-patch comment

← Older revision		Revision as of 09:57, 1 February 2011
Line 1:		Line 1:
	== Characteristics of a good patch ==		== Characteristics of a good patch ==
	A good patch should:		A good patch should:
-	* be in unified context format (diff -u)	+	* be in unified context format (<code>diff -u</code>)
		+	** alternatively, be generated with <pre>git format-patch</pre>
	* only include related changes		* only include related changes
	* not introduce any compile time warnings		* not introduce any compile time warnings
	* have test code (if any) separate from the added/changed functionality		* have test code (if any) separate from the added/changed functionality
	* not add any extra debug printing, unless absolutely necessary		* 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~~	+	* 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.	+	When attaching a patch to a bug at https://bugs.maemo.org/, add the "patch" keyword to the bug report.

	[[Category:Development]]		[[Category:Development]]

amigadave: tidy, add category

amigadave — Thu, 04 Feb 2010 13:49:49 GMT

tidy, add category

← Older revision		Revision as of 13:49, 4 February 2010
Line 1:		Line 1:
-	== Characteristics of ~~The Good Patch~~ ==	+	== Characteristics of a good patch ==
-	A ~~detailed and technical complement to~~ the ~~[[Maemo contribution guidelines]].~~	+	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

-	* The Good Patch should be in unified context format (diff -u).	+	When attaching a patch to a bug at https://bugs.maemo.org, add the "patch" keyword to the bug report.
-	* The Good Patch should not include any unrelated changes.	+
-	* The Good Patch should not generate any more compile time warnings than were already there.	+	[[Category:Development]]
-	* 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.	+

nakkebar at 08:33, 26 November 2008

nakkebar — Wed, 26 Nov 2008 08:33:10 GMT

← Older revision		Revision as of 08:33, 26 November 2008
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 ~~not include any commented~~ code ~~lines~~ from ~~tests~~.	+	* 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.

qgil: Based on Andre Klapper's input

qgil — Mon, 24 Nov 2008 10:40:29 GMT

Based on Andre Klapper's input

New page

== Characteristics of The Good Patch ==
A detailed and technical complement to the [[Maemo contribution guidelines]].

* The Good Patch should not generate any more compile time warnings than were already there.
* The Good Patch should not include any commented code lines from tests.
* 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.