clarified the contribution procedure. related NEKOGET#490

chatii · Jan 18, 2013 · 0b9ea1b · 0b9ea1b
1 parent ee866d2
commit 0b9ea1b
Showing 1 changed file with 19 additions and 9 deletions.
diff --git a/contribute.html b/contribute.html
@@ -55,7 +55,7 @@ <h3 id="introduction">Introduction</h3>
 				releasing packages, to contributing to the official parts of Fuel (Core, Orm, Docs, etc..).
 			</p>
 
-			<h3 id="fixing_bugs">Fixing Bugs</h3>
+			<h3 id="contribute_code">Contribute code</h3>
 
 			<p>
 				When you encounter a bug or see one in the issues list that you can or have resolved,
@@ -66,16 +66,20 @@ <h3 id="fixing_bugs">Fixing Bugs</h3>
 
 			<ul>
 				<li>
-					<strong>Is my current version still supported?</strong><br/>
-					If not, upgrade to a supported version and see if the bug is still exists.
+					<strong>Is the release I am currently using still supported?</strong><br/>
+					If not, upgrade to the current release, and see if the bug is still exists.
 				</li>
 				<li>
-					<strong>Checkout your version on your local repository</strong><br/>
-					<code class="cli">$ git checkout -b 1.2/develop origin/1.2/develop</code> (bugfix branch for the current release )
+					<strong>Is the bug still present in the current release?</strong><br/>
+					If so, upgrade to the current develop branch, and see if the bug is fixed there.
+				</li>
+				<li>
+					<strong>If not, checkout the current development branch on your local repository</strong><br/>
+					<code class="cli">$ git checkout -b 1.5/develop origin/1.5/develop</code>
 				</li>
 				<li>
 					<strong>Fix the bug and commit it in your local repository</strong><br/>
-					Use a descriptive and understandable commit message
+					Use a descriptive and understandable commit message, and make sure you sign it off.<br/>
 					<code class="cli">$ git commit -m "This is my awesome description."</code>
 				</li>
 				<li>
@@ -84,21 +88,27 @@ <h3 id="fixing_bugs">Fixing Bugs</h3>
 				</li>
 				<li>
 					<strong>Request the pull</strong><br/>
-					Request the pull on the same branch as you are on (or you based your branch off).
+					Request the pull on the same branch as you are on (= the current develop branch).
 					Use the "update commit range" interface to direct you request to the correct branch.
-					Pull requests are only accepted on the current release bugfix branch (1.2/develop) or the next release development branch (1.3/develop).
+					Pull requests are only accepted on the current release develop branch (1.5/develop).
 				</li>
 				<li>
 					<strong>Wait for your moment of fame</strong><br/>
 					As soon as your request is merged you'll be part of the contributors list of Fame.
 				</li>
 			</ul>
 
+			<p class="note">You can find this procedure described in more detail on <a href="https://github.com/fuel/fuel/wiki/Contributing">Github</a>.</p>
+
 			<h3 id="enhancements">Non-bug contributions</h3>
 
 			<p>
 				Non-bug contributions are new features, optimizations and all other alterations. All of these request must be made on the
-				latest development branch. So pull the 1.3/develop branch, make the changes and request a pull.
+				latest development branch. So pull the 1.5/develop branch, make the changes and request a pull.
+			</p>
+			<p>
+				For large and/or completely new features, or features that will take some time to complete, it might be wise
+				to setup a separate feature branch. Contact one of the core developers via email or on IRC to discuss the options.
 			</p>
 
 		</div>