Wiki

Changes between Version 8 and Version 9 of HowToSubmitAPatch

Timestamp:: 11/02/08 01:43:19 (15 years ago)
Author:: Chuck
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

HowToSubmitAPatch

v8	v9
68	68	}}}
69	69
	70	If you have old, commented out code that is no longer relevant due to the patch, delete it. The patch "diff" itself will show the old code and we can always retrieve it from the source code control system if we need it at a later date. Also, remove stray {{{print}}} and {{{trace}}} statements used for debugging.
	71
	72	Avoid `shared` variables as much as possible. Each one makes it harder to embed, reuse and multithread the Cobra compiler.
	73
	74	= Test Cases =
	75
70	76	In test cases, put the "# .error." or the "# .warning." on the same line that it goes with. You'll see that many tests put these at the very top, but that was the old approach before the automated testing supported the current approach: on the same line.
71
72		Update !IntermediateReleaseNotes.text in the Developer directory next door to the Source directory. Include your name or forum/Trac handle for credit. Reference tickets using Trac syntax with "ticket", colon (:) and number. (The HTML formatter for the release notes supports that.)
73	77
74	78	Be sure to add or update tests found in the Tests directory next door to the Source directory. You may wish to run the test suite ''before'' making your changes in order to see if there are any failures independent of them. You must run the test suite after your final changes to be sure nothing has been broken by them.
…	…
82	86	}}}
83	87
84		If you have old, commented out code that is no longer relevant due to the patch, delete it. The patch "diff" itself will show the old code and we can always retrieve it from the source code control system if we need it at a later date. Also, remove stray {{{print}}} and {{{trace}}} statements used for debugging.
	88	After testing, if you make any small tweaks to your code, please run the test suite again. You never know what's going to break.
85	89
86		After testing, if you make any small tweaks to your code, please run the test suite again. You never know what's going to break.
	90	= Release Notes =
	91
	92	Update !IntermediateReleaseNotes.text in the Developer directory next door to the Source directory. Include your name or forum/Trac handle for credit. Reference tickets using Trac syntax with "ticket", colon (:) and number. (The HTML formatter for the release notes supports that.)
87	93
88	94	= Submitting =