cloudstack-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From seb...@apache.org
Subject git commit: updated refs/heads/4.4 to a79fd88
Date Fri, 03 Apr 2015 08:21:08 GMT
Repository: cloudstack
Updated Branches:
  refs/heads/4.4 9a730d469 -> a79fd8816


Add CONTRIBUTING instructions


Project: http://git-wip-us.apache.org/repos/asf/cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/cloudstack/commit/a79fd881
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack/tree/a79fd881
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack/diff/a79fd881

Branch: refs/heads/4.4
Commit: a79fd8816e1fb91f2df78332380f23ea47463481
Parents: 9a730d4
Author: Sebastien Goasguen <runseb@gmail.com>
Authored: Fri Apr 3 10:18:57 2015 +0200
Committer: Sebastien Goasguen <runseb@gmail.com>
Committed: Fri Apr 3 10:20:59 2015 +0200

----------------------------------------------------------------------
 CONTRIBUTING.md | 108 +++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md       |   1 +
 pom.xml         |   1 +
 3 files changed, 110 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cloudstack/blob/a79fd881/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..95d7a85
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,108 @@
+Contributing to Apache CloudStack (ACS)
+=======================================
+
+Summary
+-------
+This document covers how to contribute to the ACS project. These instructions assume you
have a GitHub.com account, so if you don't have one you will have to create one. Your proposed
code changes will be published to your own fork of the ACS project and you will submit a Pull
Request for your changes to be added.
+
+_Lets get started!!!_
+
+
+Fork the code 
+-------------
+
+In your browser, navigate to: [https://github.com/apache/cloudstack](https://github.com/apache/cloudstack)
+
+Fork the repository by clicking on the 'Fork' button on the top right hand side.  The fork
will happen and you will be taken to your own fork of the repository.  Copy the Git repository
URL by clicking on the clipboard next to the URL on the right hand side of the page under
'**HTTPS** clone URL'.  You will paste this URL when doing the following `git clone` command.
+
+On your computer, follow these steps to setup a local repository for working on ACS:
+
+``` bash
+$ git clone https://github.com/YOUR_ACCOUNT/cloudstack.git
+$ cd cloudstack
+$ git remote add upstream https://github.com/apache/cloudstack.git
+$ git checkout master
+$ git fetch upstream
+$ git rebase upstream/master
+```
+
+
+Making changes
+--------------
+
+It is important that you create a new branch to make changes on and that you do not change
the `master` branch (other than to rebase in changes from `upstream/master`).  In this example
I will assume you will be making your changes to a branch called `feature_x`.  This `feature_x`
branch will be created on your local repository and will be pushed to your forked repository
on GitHub.  Once this branch is on your fork you will create a Pull Request for the changes
to be added to the ACS project.
+
+It is best practice to create a new branch each time you want to contribute to the project
and only track the changes for that pull request in this branch.
+
+``` bash
+$ git checkout -b feature_x
+   (make your changes)
+$ git status
+$ git add .
+$ git commit -a -m "descriptive commit message for your changes"
+```
+
+> The `-b` specifies that you want to create a new branch called `feature_x`.  You only
specify `-b` the first time you checkout because you are creating a new branch.  Once the
`feature_x` branch exists, you can later switch to it with only `git checkout feature_x`.
+
+
+Rebase `feature_x` to include updates from `upstream/master`
+------------------------------------------------------------
+
+It is important that you maintain an up-to-date `master` branch in your local repository.
 This is done by rebasing in the code changes from `upstream/master` (the official ACS project
repository) into your local repository.  You will want to do this before you start working
on a feature as well as right before you submit your changes as a pull request.  I recommend
you do this process periodically while you work to make sure you are working off the most
recent project code.
+
+This process will do the following:
+
+1. Checkout your local `master` branch
+2. Synchronize your local `master` branch with the `upstream/master` so you have all the
latest changes from the project
+3. Rebase the latest project code into your `feature_x` branch so it is up-to-date with the
upstream code
+
+``` bash
+$ git checkout master
+$ git fetch upstream
+$ git rebase upstream/master
+$ git checkout feature_x
+$ git rebase master
+```
+
+> Now your `feature_x` branch is up-to-date with all the code in `upstream/master`.
+
+
+Make a GitHub Pull Request to contribute your changes
+-----------------------------------------------------
+
+When you are happy with your changes and you are ready to contribute them, you will create
a Pull Request on GitHub to do so.  This is done by pushing your local changes to your forked
repository (default remote name is `origin`) and then initiating a pull request on GitHub.
+
+> **IMPORTANT:** Make sure you have rebased your `feature_x` branch to include the latest
code from `upstream/master` _before_ you do this.
+
+``` bash
+$ git push origin master
+$ git push origin feature_x
+```
+
+Now that the `feature_x` branch has been pushed to your GitHub repository, you can initiate
the pull request.  
+
+To initiate the pull request, do the following:
+
+1. In your browser, navigate to your forked repository: [https://github.com/YOUR_ACCOUNT/cloudstack](https://github.com/YOUR_ACCOUNT/cloudstack)
+2. Click the new button called '**Compare & pull request**' that showed up just above
the main area in your forked repository
+3. Validate the pull request will be into the upstream `master` and will be from your `feature_x`
branch
+4. Enter a detailed description of the work you have done and then click '**Send pull request**'
+
+If you are requested to make modifications to your proposed changes, make the changes locally
on your `feature_x` branch, re-push the `feature_x` branch to your fork.  The existing pull
request should automatically pick up the change and update accordingly.
+
+
+Cleaning up after a successful pull request
+-------------------------------------------
+
+Once the `feature_x` branch has been committed into the `upstream/master` branch, your local
`feature_x` branch and the `origin/feature_x` branch are no longer needed.  If you want to
make additional changes, restart the process with a new branch.
+
+> **IMPORTANT:** Make sure that your changes are in `upstream/master` before you delete
your `feature_x` and `origin/feature_x` branches!
+
+You can delete these deprecated branches with the following:
+
+``` bash
+$ git checkout master
+$ git branch -D feature_x
+$ git push origin :feature_x
+```
+

http://git-wip-us.apache.org/repos/asf/cloudstack/blob/a79fd881/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index ac077f9..7411e6b 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,7 @@ For more information on Apache CloudStack, please visit the [website](http://clo
 * [Release notes](http://docs.cloudstack.apache.org/projects/cloudstack-release-notes)
 * Design [documents](https://cwiki.apache.org/confluence/display/CLOUDSTACK/Design)
 * API [documentation](http://cloudstack.apache.org/docs/api)
+* How to [contribute](CONTRIBUTING.md)
 
 ## Getting Involved and Contributing
 

http://git-wip-us.apache.org/repos/asf/cloudstack/blob/a79fd881/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 88f780f..b889a1e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -708,6 +708,7 @@
               <exclude>INSTALL.md</exclude>
               <exclude>Dockerfile</exclude>
               <exclude>supervisord.conf</exclude>
+              <exclude>CONTRIBUTING.md</exclude>
               <exclude>.idea/</exclude>
               <exclude>**/*.log</exclude>
               <exclude>**/*.patch</exclude>


Mime
View raw message