Skip to content
This repository
Browse code

MINOR Improved patch documentation

  • Loading branch information...
commit 551bc5dc723d6b8c9276a29e8c221d5da1b64a45 1 parent f3ac573
Ingo Schommer authored March 21, 2011

Showing 1 changed file with 11 additions and 7 deletions. Show diff stats Hide diff stats

  1. 18  docs/en/misc/contributing.md
18  docs/en/misc/contributing.md
Source Rendered
@@ -17,7 +17,7 @@ If you have discovered a bug in SilverStripe, we'd be glad to hear about it -
17 17
 well written bug reports can be half of the solution already!
18 18
 Our bugtracker is located on [open.silverstripe.org](http://open.silverstripe.org/) (create a [new ticket](http://open.silverstripe.org/newticket)).
19 19
 
20  
-## Submiting Patches, Bugfixes and Enhancements
  20
+## Submiting Bugfixes and Enhancements
21 21
 
22 22
 We're not perfect, and need your help - for example in the form of patches for our modules and core codebase.
23 23
 
@@ -43,11 +43,11 @@ changes
43 43
 *  Document your code inline through [PHPDoc](http://en.wikipedia.org/wiki/PHPDoc) syntax. See our 
44 44
 [API documentation](http://api.silverstripe.org/trunk) for good examples.
45 45
 * Also check and update documentation on [doc.silverstripe.org](http://doc.silverstripe.org). Check for any references to functionality deprecated or extended through your patch. Documentation changes should be included in the patch.
46  
-* We will attribute the change to you whereever possible (git does this automatically)
  46
+* We will attribute the change to you whereever possible (git does this automatically for pull requests)
47 47
 * If you get stuck, please post to the [forum](http://silverstripe.org/forum) or for deeper core problems, to the [core mailinglist](https://groups.google.com/forum/#!forum/silverstripe-dev)
48 48
 
49 49
 The core team is responsible for reviewing patches and deciding if they will make it into core.  If
50  
-there are any problems they will assign the ticket back to you, so make sure you have an email address loaded into Trac so that it will notify you! The [Active Patches Report](http://open.silverstripe.com/report/10) will let you see where all the patches are at, and you can review outstanding "pull requests" (for [sapphire](https://github.com/silverstripe/sapphire/pulls) and [cms](https://github.com/silverstripe/silverstripe-cms/pulls)).
  50
+there are any problems they will follow up with you, so please ensure they have a way to contact you! 
51 51
 
52 52
 ### Sending pull requests (for git)
53 53
 
@@ -62,19 +62,21 @@ Example: [Fork the blog module](https://github.com/silverstripe/silverstripe-blo
62 62
 Now you have two choices: Smaller fixes (e.g. typos) can be edited directly in the github.com web interface
63 63
 (every file view has an "edit this file" link). More commonly, you will work on a working copy on your own computer. After committing your fix, you can send the module authors a so called ["pull request"](http://help.github.com/pull-requests/).
64 64
 The module authors will get notified automatically, review your patch, and merge it back as appropriate.
65  
-
66 65
 For new features, we recommend creating a ["feature branch"](http://progit.org/book/ch3-3.html) rather than a really big patch.
67 66
 
  67
+On github, you can review outstanding [sapphire pull requests](https://github.com/silverstripe/sapphire/pulls) and [cms pull requests](https://github.com/silverstripe/silverstripe-cms/pulls)).
  68
+
68 69
 If you want to learn more about git, please have a look at the [free online git book](http://progit.org/book/) and the [git crash course](http://gitref.org/).
69 70
 
70 71
 ### Submitting patches (for subversion)
71 72
 
72  
-Other modules will be hosted on [subversion](http://subversion.tigris.org), in which case you have to
  73
+Some modules will be hosted on [subversion](http://subversion.tigris.org), in which case you have to
73 74
 package your changes as a "patch" file. Please read the [official Subversion book](http://svnbook.red-bean.com/) (available free online) for a general introduction to subversion. 
74 75
 
75  
-To submit a patch, [register](http://open.silverstripe.com/register) or [Login](http://open.silverstripe.org/login) if you have already registered and attach the patch to the appropriate ticket. 
  76
+Please don't submit patch files for modules on git, as they cause us more work.
  77
+
  78
+To submit a patch, [register](http://open.silverstripe.com/register) or [login](http://open.silverstripe.org/login) on open.silverstripe.org, and attach the patch to an appropriate ticket. 
76 79
 Please include in the comment the revision number that the patch is applicable for and a brief outline of what you fixed and how. 
77  
-Only use the provided link to submit patches, as it prefills information about owner and ticket-type:
78 80
 
79 81
 [Submit a patch (requires account on open.silverstripe.org)](http://open.silverstripe.com/newticket?field_type=patch&field_owner=ischommer&attachment=1)
80 82
 
@@ -92,6 +94,8 @@ Some gotchas when using subversion and the patch format:
92 94
 *  Create patches relative to the working copy (*sapphire/main.php* instead of */Users/myuser/sapphire/main.php*)
93 95
 *  Remember the shortcomingsof *svn diff*: Please document moved files and created/deleted directories separately
94 96
 
  97
+The "[Patches: Core](http://open.silverstripe.com/report/101)" and "[Patches: Modules](http://open.silverstripe.com/report/102)" reports will let you see where all the patches are at.
  98
+
95 99
 ### Commit Messages
96 100
 
97 101
 We try to maintain a consistent record of descriptive commit messages. As we automatically generate changelogs from them, we need a way to categorize and filter. Please prefix **all** commit messages with one of the following tags: 

0 notes on commit 551bc5d

Please sign in to comment.
Something went wrong with that request. Please try again.