Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "RMF/Contributor Guide/Development Process"
< RMF
(→Contributing as Non-Committer at the University of Düsseldorf) |
|||
| Line 1: | Line 1: | ||
| − | We're still in the incubator phase - therefore, the release process is still being developed. | + | We're still in the incubator phase - therefore, the release process is still being developed. Here are our guidelines so far: |
| − | == The Most Important Stuff == | + | == The Most Important Stuff == |
| − | * '''Important:''' Never commit to master! (unless you are the release manager). | + | *'''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 | + | *We use the [http://nvie.com/posts/a-successful-git-branching-model/ Git Flow Process] as our release process |
| − | == Coding Guidelines == | + | == Coding Guidelines == |
| − | * We use the default formating rules by Eclipse to format Java Code (Ctrl-Shift-F) | + | *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) | + | *Don't format generated code (that makes it difficult to run diffs on generated code) |
| − | + | ||
| − | + | ||
== Contributing as Non-Committer at the University of Düsseldorf == | == Contributing as Non-Committer at the University of Düsseldorf == | ||
| Line 50: | Line 48: | ||
git push ssh://sshusername@git.eclipse.org:29418/rmf/org.eclipse.rmf.git HEAD:refs/for/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 [https://git.eclipse.org/r/#/settings/ settings]. | + | You can find your ''sshusername'' on your Profil [https://git.eclipse.org/r/#/settings/ settings] to which you can allocate your [https://git.eclipse.org/r/#/settings/ssh-keys SSH public key]. |
| − | For more informations you may want to take a look at the [https://git.eclipse.org/r/Documentation/user-upload.html documentation]. | + | For more informations you may want to take a look at the [https://git.eclipse.org/r/Documentation/user-upload.html documentation]. |
| + | |||
| + | [[Category:RMF]] | ||
Revision as of 13:44, 10 June 2012
We're still in the incubator phase - therefore, the release process is still being developed. Here are our guidelines so far:
The Most Important Stuff
- 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
Coding Guidelines
- 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)
Contributing as Non-Committer at the University of Düsseldorf
We will eventually use Gerrit to process contributions from Students to RMF. Those who want to contribute can set up their git as follows:
- git clone git://git.eclipse.org/gitroot/rmf/org.eclipse.rmf.git -o eclipse
- git checkout develop
- git checkout -b foobar
- git remote add cobra gitosis@cobra.cs.uni-duesseldorf.de:org.eclipse.rmf.git
- git push cobra foobar
- Edit .git/config and add:
[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.