Home Explore Help
Register Sign In
Omnimaga
/
SMF2.1
mirror of [email protected]:Omnimaga/SMF2.1.git
2
0
Fork 0
Files Issues 0 Wiki
Browse Source

Update README.md with instructions on how to contribute (sorry for the direct commit...)

Signed-off-by: emanuele <[email protected]>
emanuele 11 years ago
parent
2d3995e722
commit
10f8066483
1 changed files with 12 additions and 1 deletions
Split View Show Diff Stats
  1. 12 1
      README.md

+ 12 - 1
README.md
View File 

@@ -9,9 +9,14 @@ Contributions to documentation are licensed under [CC-by-SA 3](http://creativeco
 
 
 Feel free to fork this repository and make your desired changes.
 
 
-Please see the [Developer's Certificate of Origin](https://github.com/Spuds/playpen/blob/master/DCO.txt) in the repository:
 
+Please see the [Developer's Certificate of Origin](https://github.com/SimpleMachines/SMF2.1/blob/master/DCO.txt) in the repository:
 
 by signing off your contributions, you acknowledge that you can and do license your submissions under the license of the project.
 
 
+######Branches organization:
 
+* ***master*** - is the main branch, only used to merge in a "final release"
 
+* ***development*** - is the branch where the development of the "next" version/s happens
 
+* ***release-2.1*** - is the branch where bug fixes for the version 2.1 are applied
 
+
 
 ######How to contribute:
 
 * fork the repository. If you are not used to Github, please check out [fork a repository](http://help.github.com/fork-a-repo).
 
 * branch your repository, to commit the desired changes.
 
@@ -19,5 +24,11 @@ by signing off your contributions, you acknowledge that you can and do license y
 
  * an easy way to do so, is to define an alias for the git commit command, which includes -s switch (reference: [How to create Git aliases](http://githacks.com/post/1168909216/how-to-create-git-aliases))
 
 * send a pull request to us.
 
 
+######How to submit a pull request:
 
+* If you want to send a bug fix for the version 2.1, send it to the branch ***release-2.1***
 
+* If you want to send a new feature, use the branch ***development***
 
+* You should never send any pull request against the master branch
 
+For more informations, the ideal branching we would like to follow is the one described in [this article](http://nvie.com/posts/a-successful-git-branching-model/)
 
+
 
 Finally, feel free to play around. That's what we're doing. ;)