Revision: 5ec995cd5c5c
Author: jean.deruelle <[email protected]>
Date: Tue Jul 17 12:52:56 2012
Log: Edited wiki page Contribute through web user interface.
http://code.google.com/p/sipservlets/source/detail?r=5ec995cd5c5c&repo=wiki
Modified:
/Contribute.wiki
=======================================
--- /Contribute.wiki Fri Apr 6 06:07:57 2012
+++ /Contribute.wiki Tue Jul 17 12:52:56 2012
@@ -1,4 +1,5 @@
#summary Contribute to Mobicents SIP Servlets
+#labels contribute
= Contribute =
@@ -21,4 +22,134 @@
In order to become a contributor with write access to the code, you will
need to have demonstrated an understanding of the codebase and testsuite by
participating in the design discussions and submitting patches for
bugs/enchancements before we will grant developer access.
Developer role requires you to accept [http://telestax.com/open-source/
the contributor agreement] (bottom of the page).
-Next, apply for Developer role in mailing one of the project owners with
your google account email address. One of the project owners must use the
project administration page to add your Google account email address to the
Mobicents Project .
+Next, apply for Developer role in mailing one of the project owners with
your google account email address. One of the project owners must use the
project administration page to add your Google account email address to the
Mobicents Project.
+
+
+= How to check out, change, review, and commit code =
+== Introduction ==
+
+Mobicents projects use Git, a distributed version control system. What
this means is that, even though this page hosts a central repository, there
can be many clone repositories with changes of their own, and then some of
those can be merged back into the main repository.
+
+This document describes the workflow for checking out code, making clones,
reviewing patches, and committing code.
+
+== Checking out Mobicents SIP Servlets (Linux) ==
+For non-committers, checking out code is simple.
+
+=== Install Git ===
+
+Follow the installing Git instructions. Ubuntu users can simply type:
+
+{{{
+sudo apt-get install git-core
+}}}
+
+Configure Git to convert line endings on commit
+
+{{{
+git config --global core.autocrlf input
+}}}
+
+=== Checkout the code ===
+
+Follow the [http://code.google.com/p/sipservlets/source/checkout checkout
instructions] to check out the code :
+
+{{{
+git clone https://code.google.com/p/sipservlets
+}}}
+
+=== Committing code ===
+
+The model we've chosen for developing Mobicents SIP Servlets is the
following:
+
+Each contributor creates a Google Code Project Hosting clone of the main
Mobicents SIP Servlets repository.
+
+This clone is hosted on Google servers, and can be created by clicking
*Create a clone* button from
http://code.google.com/p/sipservlets/source/checkout or
http://code.google.com/p/sipservlets/source/clones
+
+Pick up a name for your repository, by example
http://code.google.com/r/jeanderuelle-test-fork
+
+The contributor then makes a local clone of their Google Code Project
Hosting clone, which is stored on their local machine.
+Instructions for checking it out is
http://code.google.com/r/jeanderuelle-test-fork/source/checkout
+
+The contributor creates a new Issue explaining their contribution at
+http://code.google.com/p/sipservlets/issues/entry?template=Review%20request
+
+The contributor then creates a new branch into their local clone
+
+{{{
+git checkout -b feature-branch
+}}}
+
+Do the changes into their branch for their local branch for the
contribution and commit them
+
+{{{
+git commit -a -m "commit message"
+}}}
+
+_*IMPORTANT*:Please use the Google Code integration to use the commit
message to tie the commits to the Issue you're working on. More information
on that can be found at
http://code.google.com/p/support/wiki/IssueTracker#Integration_with_version_control_
+
+_*IMPORTANT*: When your change is pulled into the main PlayN source, the
change description that you entered here will show up as changes in the
main PlayN source, so please use a meaningful description - fixing bug,
making changes, etc. are not ok, please instead use something like fixing
transform bug caused by NPE, etc. so that it makes sense in the context of
PlayN as a whole, not just your clone._
+
+If you have any new files, make sure to use the following command before
committing
+
+{{{
+git add <file or directory>
+}}}
+
+Same thing if you want to remove some files
+
+{{{
+git rm <file or directory>
+}}}
+
+== Pushing changes to your online clone ==
+
+When a change is ready to be integrated back into the repository, that
change is pushed from the developer's local clone to their Google Code
Project Hosting clone.
+
+{{{
+git push origin feature-branch
+}}}
+
+To avoid merge soup, please rebase your branch first
+
+==== Bringing in new changes from the upstream repository ====
+
+If the main repository has evolved since your last push to your clone
repository, you will need to bring those changes into your repository as
well as potentially merge them.
+
+You need to add a remote via which you will identify the upstream
repository:
+
+{{{
+git remote add upstream https://code.google.com/p/playn/
+}}}
+
+Now whenever you want to merge upstream changes into your clone, do the
following:
+
+{{{
+git fetch upstream
+git merge upstream/master
+}}}
+
+==== Pushing changes to your clone repository ====
+
+First pull in all of the latest changes from upstream, apply them to your
master branch, then rebase your feature branch against master before
merging it into master and pushing it upstream:
+
+{{{
+git checkout master
+git fetch upstream
+git merge upstream/master
+git checkout awesome-feature
+git rebase master
+(fix any conflicts with upstream changes)
+git push origin feature-branch
+}}}
+
+Browse to Source -> Changes from the project page for your clone and
navigate to the page with details on the branch to be reviewed.
+By example,
http://code.google.com/r/jeanderuelle-test-fork/source/list?name=feature-branch
+
+You will need to paste the URL for this page into the issue you created
earlier.
+Describe the code to be reviewed, its purpose, and paste in the URL for
the relevant changeset(s) or branch(es).
+
+The code will be reviewed on the contributor's clone - if any further
changes are suggested, a couple of iterations might be needed so the
contributor will need to modify the code again, commit, push and comment on
the issue.
+
+Once the change is approved, a committer of Mobicents SIP Servlets will
merge it back into the main repository.
+
+Even though this may sound complicated, this process makes code reviews
easier and allows a lot of people to work on changes in parallel.