Difference between revisions of "RMF/Contributor Guide/Development Process"

Revision as of 10:50, 9 November 2012

We're still in the incubator phase - therefore, the release process is still being developed. Here are our guidelines so far:

Important: Never commit to master! (unless you are the release manager). Development takes place on the develop branch
We use the Git Flow Process as our release process

We use the default formating rules by Eclipse to format Java Code (Ctrl-Shift-F)
Don't format generated code (that makes it difficult to run diffs on generated code)

We will eventually use Gerrit to process contributions from Students to RMF. Those who want to contribute can set up their git as follows:

 [branch "foobar"]
remote = cobra
merge = refs/heads/foobar

Setup is now complete. To work on the code on branch foobar, do the following:

Edit on branch foobar
Push (implicitly to cobra)
To update from the Eclipse repository:
- git checkout develop
- git pull
- git checkout foobar
- git merge develop

There may be a better way for doing all this. Please improve if you know how.

Create Changes:
To create new changes for review, simply push into the project’s magical refs/for/'branch' ref .

 git push ssh://sshusername@hostname:29418/projectname HEAD:refs/for/branchname

in our case the hostname would be git.eclipse.org ,the projectname /rmf/org.eclipse.rmf.git and the branch develop

 git push ssh://sshusername@git.eclipse.org:29418/rmf/org.eclipse.rmf.git HEAD:refs/for/develop

You can find your sshusername on your Profil settings to which you can allocate your SSH public key.

For more informations you may want to take a look at the documentation.

@@ Line 3: / Line 3: @@
 == The Most Important Stuff  ==
-*'''Important:''' Never commit to master! (unless you are the release manager). Development takes place on the develop branch)
+*'''Important:''' Never commit to master! (unless you are the release manager). Development takes place on the develop branch
 *We use the [http://nvie.com/posts/a-successful-git-branching-model/ Git Flow Process] as our release process