Changes between Version 19 and Version 20 of TracDev/SubmittingPatches

Timestamp:

May 15, 2017, 8:07:03 AM (7 years ago)

Author:

Ryan J Ollos

Comment:

Improve formatting and reword some parts.

TracDev/SubmittingPatches

@@ -33 +33 @@
 
 Bug fixes for a current release may be added on the "stable" branch:
-{{{
-svn checkout http://svn.edgewall.org/repos/trac/branches/0.12-stable trac-0.12-stable
+{{{#!sh
+$ svn checkout https://svn.edgewall.org/repos/trac/branches/1.2-stable trac-1.2-stable
 }}}
 
 Features should be added on the "trunk" development version:
-{{{
-svn checkout http://svn.edgewall.org/repos/trac/trunk trac-trunk
+{{{#!sh
+$ svn checkout https://svn.edgewall.org/repos/trac/trunk trac-trunk
 }}}
 
@@ -62 +62 @@
 Did you create any new files? If you only modified existing Trac files you can skip this. However, if you added any new files be sure to tell Subversion you're adding them:
 
-{{{
-svn add trac/my_new_file.py
+{{{#!sh
+$ svn add trac/my_new_file.py
 }}}
 
@@ -71 +71 @@
 
 Save your changes to the file "my_patch_file.diff":
-{{{
-svn diff > my_patch_file.diff
+{{{#!sh
+$ svn diff > my_patch_file.diff
 }}}
 
@@ -82 +82 @@
 
 With Mercurial, assuming your patch corresponds to the latest commit:
-{{{
-hg export tip > my_patch_file.diff
+{{{#!sh
+$ hg export tip > my_patch_file.diff
 }}}
 
 With Git, assuming your patch corresponds to the head:
-{{{
-git show > my_patch_file.diff
+{{{#!sh
+$ git show > my_patch_file.diff
 }}}
 
 == Submit the patch
 
-If there is an existing ticket related to the changes you've made, attach your patch file to that ticket. Otherwise please create a new ticket and attach your patch file. Provide a comment briefly explaining your changes.
+If there is an existing ticket related to the changes you've made, attach your patch file to that ticket. Otherwise please create a new ticket and attach your patch file. Provide a brief comment explaining your changes.
 
-Add the keyword `patch` as a hint to developers that a patch has been provided.
+Add the keyword [kwquery:patch] as a hint to developers that a patch has been provided.
 
-After that, depending on lots of factors, your patch will be reviewed and eventually integrated. Most probably, you'll be asked to rework your patch a bit, according to the preferences of the Trac maintainers. 
+After that, depending on lots of factors, your patch will be reviewed and eventually integrated. Most likely, you'll be asked to rework your patch a bit, according to the preferences of the Trac maintainers. 
 
 == What is a good patch?
@@ -105 +105 @@
  - clarity
    - no spurious changes like whitespace change or other random reformattings
-   - no unrelated changes; if some refactoring really needs to be done as a preliminary to the actual change, better do that in a separate patch
+   - no unrelated changes; if some refactoring really needs to be done prior to the actual change, better do that in a separate patch
    - strict adherence to the CodingStyle
  - maintainability