Skip to content
This repository
Browse code

MINOR Updated contributing guidelines

Conflicts:

	docs/en/misc/contributing.md
  • Loading branch information...
commit 4c1866c74cc58499926eb9bdbc34b3ed521fc1be 1 parent 918d9cb
Ingo Schommer authored March 21, 2011

Showing 1 changed file with 8 additions and 6 deletions. Show diff stats Hide diff stats

  1. 14  docs/en/misc/contributing.md
14  docs/en/misc/contributing.md
Source Rendered
@@ -31,6 +31,7 @@ General guidelines:
31 31
 
32 32
 *  Adhere to our [coding conventions](coding-conventions)
33 33
 *  If your patch is extensive, discuss it first on the [silverstripe forum](http///www.silverstripe.org/forums/) (ideally before doing any serious coding)
  34
+*  When working on existing tickets, assign them to you and provide status updates through ticket comments
34 35
 *  Check your patches against the latest "trunk" or "master", as well as the latest release. 
35 36
 Please not that the latest stable release will often not be sufficient! (of all modules)
36 37
 *  Provide complete [unit test coverage](/topics/testing) - depending on the complexity of your work, this is a required
@@ -42,6 +43,11 @@ changes
42 43
 *  Document your code inline through [PHPDoc](http://en.wikipedia.org/wiki/PHPDoc) syntax. See our 
43 44
 [API documentation](http://api.silverstripe.org/trunk) for good examples.
44 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)
  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
+
  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)).
45 51
 
46 52
 ### Sending pull requests (for git)
47 53
 
@@ -53,7 +59,8 @@ which creates a copy that you can commit to (see github's [guide to "forking"](h
53 59
 
54 60
 Example: [Fork the blog module](https://github.com/silverstripe/silverstripe-blog)
55 61
 
56  
-After committing your fix, you can send the module authors a so called ["pull request"](http://help.github.com/pull-requests/).
  62
+Now you have two choices: Smaller fixes (e.g. typos) can be edited directly in the github.com web interface
  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/).
57 64
 The module authors will get notified automatically, review your patch, and merge it back as appropriate.
58 65
 
59 66
 For new features, we recommend creating a ["feature branch"](http://progit.org/book/ch3-3.html) rather than a really big patch.
@@ -71,11 +78,6 @@ Only use the provided link to submit patches, as it prefills information about o
71 78
 
72 79
 [Submit a patch (requires account on open.silverstripe.org)](http://open.silverstripe.com/newticket?field_type=patch&field_owner=ischommer&attachment=1)
73 80
 
74  
-The core team is responsible for reviewing the patches and deciding if they will make it into core.  If
75  
-there are any problems they will assign the ticket back to you, so make sure you have an email address loaded into Trac
76  
-so that it will notify you! The Trac reports [Core Patches](http://open.silverstripe.com/report/101) and [Module Patches](http://open.silverstripe.com/report/102) will let you see
77  
-where all the patches are at.
78  
-
79 81
 You can create a patch file through the svn diff-command on the command-line. 
80 82
 More info in the [svn redbook](http://svnbook.red-bean.com/en/1.1/ch03s05.html#svn-ch-3-sect-5.3.2). 
81 83
 Your code editor might have a GUI for creating patches.

0 notes on commit 4c1866c

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