Browse files

MINOR Improved patch documentation

  • Loading branch information...
chillu committed Mar 20, 2011
1 parent f3ac573 commit 551bc5dc723d6b8c9276a29e8c221d5da1b64a45
Showing with 11 additions and 7 deletions.
  1. +11 −7 docs/en/misc/
@@ -17,7 +17,7 @@ If you have discovered a bug in SilverStripe, we'd be glad to hear about it -
well written bug reports can be half of the solution already!
Our bugtracker is located on []( (create a [new ticket](
-## Submiting Patches, Bugfixes and Enhancements
+## Submiting Bugfixes and Enhancements
We're not perfect, and need your help - for example in the form of patches for our modules and core codebase.
@@ -43,11 +43,11 @@ changes
* Document your code inline through [PHPDoc]( syntax. See our
[API documentation]( for good examples.
* Also check and update documentation on []( Check for any references to functionality deprecated or extended through your patch. Documentation changes should be included in the patch.
-* We will attribute the change to you whereever possible (git does this automatically)
+* We will attribute the change to you whereever possible (git does this automatically for pull requests)
* If you get stuck, please post to the [forum]( or for deeper core problems, to the [core mailinglist](!forum/silverstripe-dev)
The core team is responsible for reviewing patches and deciding if they will make it into core. If
-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]( will let you see where all the patches are at, and you can review outstanding "pull requests" (for [sapphire]( and [cms](
+there are any problems they will follow up with you, so please ensure they have a way to contact you!
### Sending pull requests (for git)
@@ -62,19 +62,21 @@ Example: [Fork the blog module](
Now you have two choices: Smaller fixes (e.g. typos) can be edited directly in the web interface
(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"](
The module authors will get notified automatically, review your patch, and merge it back as appropriate.
For new features, we recommend creating a ["feature branch"]( rather than a really big patch.
+On github, you can review outstanding [sapphire pull requests]( and [cms pull requests](
If you want to learn more about git, please have a look at the [free online git book]( and the [git crash course](
### Submitting patches (for subversion)
-Other modules will be hosted on [subversion](, in which case you have to
+Some modules will be hosted on [subversion](, in which case you have to
package your changes as a "patch" file. Please read the [official Subversion book]( (available free online) for a general introduction to subversion.
-To submit a patch, [register]( or [Login]( if you have already registered and attach the patch to the appropriate ticket.
+Please don't submit patch files for modules on git, as they cause us more work.
+To submit a patch, [register]( or [login]( on, and attach the patch to an appropriate ticket.
Please include in the comment the revision number that the patch is applicable for and a brief outline of what you fixed and how.
-Only use the provided link to submit patches, as it prefills information about owner and ticket-type:
[Submit a patch (requires account on](
@@ -92,6 +94,8 @@ Some gotchas when using subversion and the patch format:
* Create patches relative to the working copy (*sapphire/main.php* instead of */Users/myuser/sapphire/main.php*)
* Remember the shortcomingsof *svn diff*: Please document moved files and created/deleted directories separately
+The "[Patches: Core](" and "[Patches: Modules](" reports will let you see where all the patches are at.
### Commit Messages
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 comments on commit 551bc5d

Please sign in to comment.