airavata-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r919712 - in /websites/staging/airavata/trunk/content: ./ community/how-to-commit-contributed-code.html community/how-to-contribute-code.html
Date Mon, 18 Aug 2014 15:33:10 GMT
Author: buildbot
Date: Mon Aug 18 15:33:10 2014
New Revision: 919712

Log:
Staging update by buildbot for airavata

Added:
    websites/staging/airavata/trunk/content/community/how-to-commit-contributed-code.html
Modified:
    websites/staging/airavata/trunk/content/   (props changed)
    websites/staging/airavata/trunk/content/community/how-to-contribute-code.html

Propchange: websites/staging/airavata/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Aug 18 15:33:10 2014
@@ -1 +1 @@
-1617268
+1618633

Added: websites/staging/airavata/trunk/content/community/how-to-commit-contributed-code.html
==============================================================================
--- websites/staging/airavata/trunk/content/community/how-to-commit-contributed-code.html
(added)
+++ websites/staging/airavata/trunk/content/community/how-to-commit-contributed-code.html
Mon Aug 18 15:33:10 2014
@@ -0,0 +1,185 @@
+<!DOCTYPE html>
+<html>
+<head>
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE- 2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+  <title>How to Contribute Code to Apache Airavata</title>
+    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+    <link rel="stylesheet" type="text/css" media="screen" href="/css/bootstrap.min.css">
+    <style type="text/css">
+	  body {
+		  padding-top: 5px;
+		  padding-bottom: 0px;
+	  }
+	  #main { margin-top:40px; } 
+	  
+	  .sidebar-nav {
+		  padding: 9px 0;
+	  }
+	  .navbar .brand {
+		  color: white;
+	   }
+	   @media (max-width: 980px) {
+	  /* Enable use of floated navbar text */
+	  .navbar-text.pull-right {
+		  float: none;
+		  padding-left: 5px;
+		  padding-right: 5px;
+	  }
+	  }
+	  .footer p {
+		text-align: center;
+		margin-bottom: 0px;
+		color: #777;
+	  }
+	  .footer {
+		 text-align: center;
+		 padding: 30px 0px;
+		 margin-top: 20px;
+		 border-top: 1px solid #E5E5E5;
+		 background-color: whiteSmoke;
+	  }
+	</style>
+    <link rel="stylesheet" type="text/css" media="screen" href="/css/bootstrap-responsive.min.css">
+    
+    
+    <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor
license agreements.  See the NOTICE file distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file to you under the Apache License,
Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at . http://www.apache.org/licenses/LICENSE-2.0
. Unless required by applicable law or agreed to in writing, software distributed under the
License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS
OF ANY KIND, either express or implied.  See the License for the specific language governing
permissions and limitations under the License. -->
+</head>
+
+<body> 
+  <div class="navbar navbar-inverse navbar-fixed-top">
+    <div class="navbar-inner">
+      <div class="container">
+        <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+        </a>
+		<a class="brand" href="/index.html">Apache Airavata&trade;</a>
+        <div class="nav-collapse">
+          <ul class="nav pull-right">
+            <li class="dropdown">
+            <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Software
Foundation<b class="caret"></b></a>
+            <ul class="dropdown-menu">
+              <li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+              <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+              <li><a href="http://www.apache.org/foundation/sponsorship.html">Become
a Sponsor</a></li>
+              <li><a href="http://www.apache.org/security/">Security</a></li>
+             </ul>
+            </li>
+          </ul>
+        </div><!-- /.nav-collapse -->
+      </div><!-- /.container -->
+    </div><!-- /.navbar-inner -->
+  </div>
+ 
+ 
+   <div id="main" role="main" class="container">
+    
+      <header class="row page-header">
+        <div class="span3">
+          <img id="logo" alt="Apache Airavata" src="/images/airavata-logo-2.png"/>
+        </div>      
+        <div class="span9" align="center">
+      	  <img id="logo-text"  alt="Apache Airavata&trade;" class="logo pagination-centered"
src="/images/airavata-title-text.png"/>          
+        </div>
+      </header>
+       
+      <section id="content" class="row">
+        <div class="span3">
+          <div class="well sidebar-nav">
+            <ul class="nav nav-list">
+              <li class="nav-header">Apache Airavata</li>
+              <li  ><a href="/index.html">Home</a></li>
+              <li><a href="/about/license.html">License</a></li>
+              <li><a href="/about/history.html">Legacy</a></li>
+              <li><a href="/about/downloads.html">Downloads</a></li>
       
+            <li class="nav-header">Development</li>
+              <li><a href="/development/source.html">Source Code</a></li>
+              <li><a href="https://issues.apache.org/jira/browse/airavata">Issue
Tracker</a></li>
+              <li><a href="/development/roadmap.html">Road Map</a></li>
+              <li><a href="/tools/devtools.html">Dev Tools</a></li>
+              <li><a href="/development/edit-cms-website.html">Editing Website</a></li>
+              <li><a href="/development/release-management.html">Release Management</a></li>
+            <li class="nav-header">Documentation</li>
+              <li><a href="/architecture/overview.html">Architecture</a></li>
+              <li><a href="/architecture/airavata-stakeholders.html">Airavata
Stakeholders</a></li>
+              <li><a href="/documentation/quickstart-tutorials.html">Quickstart
Tutorials</a></li>
+              <li><a href="https://cwiki.apache.org/confluence/display/AIRAVATA/"
target="_blank">Airavata Wiki</a></li>
+            <li class="nav-header">Community</li>
+              <li><a href="/community/people.html">People</a></li>
+              <li><a href="/community/mailing-lists.html">Mailing Lists</a></li>
+              <li><a href="/community/get-involved.html">Get Involved</a></li>
+              <li><a href="/community/projects-using.html">Projects Using Airavata</a></li>
+           </ul>
+          </div><!--/.well --> 
+      </div><!--/span-->
+      <div class="span9">
+      	<section id="content" class="row">
+        	<article class="span9">
+          	<h3 id="accepting-contributed-code">Accepting Contributed Code</h3>
+<p>Apache Airavata follows the core philosophy of the Apache Software Foundation, informally
quoted as "Apache Way". To ensure the contributions have both legally complaint as well as
merotically rewarded, following guidlines should be used.</p>
+<ul>
+<li>Prefered contribution is by submitting patches through Airavata JIRA. The contributors
while uploading the PATCH accept the donation of the copy right to ASF. </li>
+<li>GitHUB pull requests can be accepted as a developer conveniance, but the individuals
should have a ICLA on file that covers the contributions. When in question, ask on the dev
list. </li>
+<li>Committers accepting the pull requests needs to ensure appropriate credit is given.
Merged committs should annotate to the individual who authored the commit. This is done by
ensuing both name and email addresses are preserved. </li>
+<li>Its better to preverse linear commit history and avoiding merged commits. </li>
+</ul>
+<p>Note: This page describes steps for accepting previously contributed code and is
relavent for Airavata committers. Contributors should refer to <a href="how-to-contribute-code.html">Airavata
Contributor Guide</a></p>
+<h4 id="contributed-by-a-patch-file">Contributed by a PATCH file</h4>
+<p>If the contributor has submitted a patch file on mailing list or JIRA (prefered),
follow these steps to commit it.</p>
+<ol>
+<li>First update your local checkout with any remote changes (git pull).
+ Observe the changes in the patch. Git apply -stat shows the stats about the changes in the
patch. Example: <code>git apply --stat AIRAVATA-XXXX.patch</code></li>
+<li>Test if the patch can be seamlessly applied. Example: <code>git apply --check
AIRAVATA-XXXX.patch</code></li>
+<li>Apply the patch. Use git am instead of git apply so signoff can be used to preserve
the contributor as well as annotated by the committer accepting it. Example: <code>git
am --signoff &lt; AIRAVATA-XXXX.patch</code></li>
+<li>Its a good practice to run the full build with test enabled to ensure the patch
did not break the code. </li>
+<li>Finally push the patch to remote master/branch using git push.</li>
+</ol>
+<h4 id="contributed-by-a-github-pull-request">Contributed by a GitHUB Pull request</h4>
+<p>Its preferable to clone a new copy into a temporary location (or maintain one for
contributions). This ensures the contributors changes do not get tangled with your local development.
The following steps list out a fresh checkout, adapt them to use your previous checkout. </p>
+<ol>
+<li>Clone the Airavata repo:<code>git clone https://git-wip-us.apache.org/repos/asf/airavata.git</code>.
<code>cd airavata</code> (if the PR is for a branch, do a appropriate checkout)</li>
+<li>Configure Airavata GitHUB mirror<ul>
+<li>If you previously have not done add the github mirror: <code>git remote add
github git@github.com:apache/airavata.git</code></li>
+<li>Configure to include pull requests: <code>git config --local --add remote.github.fetch
'+refs/pull/*/head:refs/remotes/github/pr/*'</code></li>
+<li>(optional) you can check out pull requests as a branch and test/review it. Example:
<code>git checkout github/pr/3</code>. <a href="https://help.github.com/articles/checking-out-pull-requests-locally">Github
PR Local checkout</a> lists this steps in detail. </li>
+</ul>
+</li>
+<li>Pick the changes you want to merge from the pull requests: <code>git cherry-pick
hash-to-merge</code>.</li>
+<li>Its a good practice to run the full build with test enabled to ensure the patch
did not break the code.</li>
+<li>Finally push the patch to remote master/branch using git push.</li>
+</ol>
+        	</article>
+    	</section>
+      </div><!--/span-->
+    </section><!--/section-->
+  </div><!--/main-->
+ 
+ <footer class="footer">
+	<div class="container">
+    	<p>Copyright &copy; 2014 The Apache Software Foundation, Licensed under the

+        	<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version
2.0</a>.<br />
+          	Apache Airavata, Apache, the Apache feather logo are trademarks of The Apache
Software Foundation.</p>
+  	</div>
+  </footer>
+  
+  <script src="/js/jquery-1.9.1.min.js"></script> 
+  <script src="/js/bootstrap.min.js"></script>
+</body>
+</html>

Modified: websites/staging/airavata/trunk/content/community/how-to-contribute-code.html
==============================================================================
--- websites/staging/airavata/trunk/content/community/how-to-contribute-code.html (original)
+++ websites/staging/airavata/trunk/content/community/how-to-contribute-code.html Mon Aug
18 15:33:10 2014
@@ -139,7 +139,7 @@
 <h4 id="create-an-issue-in-jira">Create an issue in JIRA</h4>
 <p>If it’s a bug or a feature request, open a JIRA issue. Create a sample that
you can use for prototyping the feature or demonstrating the bug. If creating a sample is
time consuming, write steps to reproduce the issue. Attach this sample to the JIRA issue if
it’s representing a bug report.   </p>
 <h4 id="create-a-pull-request-in-github">Create a pull request in GitHub</h4>
-<p><a href="source.html">Checkout</a> the source code. Create a pull request
(PR) in GitHub for the change you're interested in making. The comment section of the PR must
contain a link to the JIRA issue. Please also reference the issue in the commit message, and
make sure it properly describes the changes that have been made and their purpose.</p>
+<p><a href="development/source.html">Checkout</a> the source code. Create
a pull request (PR) in GitHub for the change you're interested in making. The comment section
of the PR must contain a link to the JIRA issue. Please also reference the issue in the commit
message, and make sure it properly describes the changes that have been made and their purpose.</p>
 <p>Some good references for working with GitHub are below. We ask that you keep your
change rebased to master as much as possible, and we will ask you to rebase again if master
has moved before accepting your patch.   </p>
 <ul>
 <li><a href="https://help.github.com/articles/set-up-git">Setting Up Git with
GitHub</a></li>
@@ -152,7 +152,9 @@
 <h4 id="the-review-process">The review process</h4>
 <p>The airavata community will need to review your pull request before it is merged.
If we are slow to respond, feel free to also email the dev mailing list: dev@airavata.apache.org.
   </p>
 <p>During the review process you may be asked to make some changes to your submission.
While working through feedback, it can be beneficial to create new commits so the incremental
change is obvious. This can also lead to a complex set of commits, and having an atomic change
per commit is preferred in the end. Use your best judgement and work with your reviewer as
to when you should revise a commit or create a new one.</p>
-<p>A pull request is considered ready to be merged once it gets at lease one +1 from
a reviewer. Once all the changes have been completed and the pull request is accepted, it
must be rebased to the latest upstream version. It is also a good idea to squash all the commits
into a single one, since this will allow us to generate a clean patch and merge it properly.
  </p>
+<p>A pull request is considered ready to be merged once it gets at lease one +1 from
a reviewer. Once all the changes have been completed and the pull request is accepted, it
must be rebased to the latest upstream version. It is also a good idea to squash all the commits
into a single one, since this will allow us to generate a clean patch and merge it properly.</p>
+<h4 id="accepting-contributions">Accepting Contributions</h4>
+<p>Developers with Airavata Commit access should read <a href="how-to-commit-contributed-code.html">Accepting
Contribtions</a> on steps to accept the contributed code</p>
         	</article>
     	</section>
       </div><!--/span-->



Mime
View raw message