You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lens.apache.org by pr...@apache.org on 2015/08/11 14:20:56 UTC

[33/50] [abbrv] incubator-lens git commit: LENS-708 : Improve 'how to commit' doc

LENS-708 : Improve 'how to commit' doc


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

Branch: refs/heads/current-release-line
Commit: b8db1740faa52d0f83c2d3bc18b3612622522af8
Parents: 06e5230
Author: Yash Sharma <ya...@apache.org>
Authored: Thu Aug 6 08:38:54 2015 +0530
Committer: Raju Bairishetti <ra...@apache.org>
Committed: Thu Aug 6 08:38:54 2015 +0530

----------------------------------------------------------------------
 pom.xml                           | 47 ++++++++++++++++++++++----------
 src/site/apt/developer/commit.apt | 50 +++++++++++++++++++++++++++++-----
 2 files changed, 76 insertions(+), 21 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/b8db1740/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 3c98077..2881815 100644
--- a/pom.xml
+++ b/pom.xml
@@ -191,7 +191,16 @@
         <role>Committer</role>
       </roles>
     </developer>
-
+    <developer>
+      <id>arshadmatin</id>
+      <email>arshadmatin@apache.org</email>
+      <name>Arshad Matin</name>
+      <timezone>+5.5</timezone>
+      <roles>
+        <role>PPMC</role>
+        <role>Committer</role>
+      </roles>
+    </developer>
     <developer>
       <id>gunther</id>
       <email>gunther@apache.org</email>
@@ -203,6 +212,16 @@
       </roles>
     </developer>
     <developer>
+      <id>himanshugahlaut</id>
+      <email>himanshugahlaut@apache.org</email>
+      <name>Himanshu Gahlaut</name>
+      <timezone>+5.5</timezone>
+      <roles>
+        <role>PPMC</role>
+        <role>Committer</role>
+      </roles>
+    </developer>
+    <developer>
       <id>jdhok</id>
       <email>jdhok@apache.org</email>
       <name>Jaideep Dhok</name>
@@ -233,6 +252,16 @@
       </roles>
     </developer>
     <developer>
+      <id>raju</id>
+      <email>raju@apache.org</email>
+      <name>Raju Bairishetti</name>
+      <timezone>+5.5</timezone>
+      <roles>
+        <role>PPMC</role>
+        <role>Committer</role>
+      </roles>
+    </developer>
+    <developer>
       <id>sharad</id>
       <email>sharad@apache.org</email>
       <name>Sharad Agarwal</name>
@@ -283,19 +312,9 @@
       </roles>
     </developer>
     <developer>
-      <id>himanshugahlaut</id>
-      <email>himanshugahlaut@apache.org</email>
-      <name>Himanshu Gahlaut</name>
-      <timezone>+5.5</timezone>
-      <roles>
-        <role>PPMC</role>
-        <role>Committer</role>
-      </roles>
-    </developer>
-    <developer>
-      <id>arshadmatin</id>
-      <email>arshadmatin@apache.org</email>
-      <name>Arshad Matin</name>
+      <id>yash</id>
+      <email>yash@apache.org</email>
+      <name>Yash Sharma</name>
       <timezone>+5.5</timezone>
       <roles>
         <role>PPMC</role>

http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/b8db1740/src/site/apt/developer/commit.apt
----------------------------------------------------------------------
diff --git a/src/site/apt/developer/commit.apt b/src/site/apt/developer/commit.apt
index 6982ead..8235798 100644
--- a/src/site/apt/developer/commit.apt
+++ b/src/site/apt/developer/commit.apt
@@ -33,6 +33,25 @@ Committer Guide
 
   * {{{http://www.apache.org/dev/committers.html#committer-responsibilities} Committer Responsibilities}}
 
+  * As first commit - Add your name to the list of Committers in pom.xml of the project. Follow the steps in commit section for instructions.
+  A typical committer tag would look like
+
++---
+
+<developer>
+  <id>amareshwari</id>
+  <email>amareshwari@apache.org</email>
+  <name>Amareshwari Sriramadasu</name>
+  <timezone>+5.5</timezone>
+  <roles>
+    <role>PPMC</role>
+    <role>Committer</role>
+  </roles>
+</developer>
+
++---
+
+
 * Review
 
   Lens committers should, as often as possible, attempt to review patches submitted by others. Ideally every submitted
@@ -69,6 +88,15 @@ Committer Guide
   * Ensure that 24 hours have elapsed since the jira is made patch available or the review request is up. As a practice
    we should observe this, but it should be possible to consciously override and commit with a shorter turnaround time.
 
+  * Cross check if your git user.name and user.email are properly configured. Set username and email with commands
+
++---+
+
+git config user.name "Amareshwari Sriramadasu"
+git config user.email "amareshwari@apache.org"
+
++---+
+
   * Apply the patch attached on jira. The patch should be licensed under apache license.
 
 +---+
@@ -83,17 +111,11 @@ Committer Guide
   * Include the Jira issue id in the commit message, along with a short description of the change and the name of the
     contributor. Be sure to get the issue id right, as this causes Jira to link to the change in git.
 
-+---+
-
-    Example commit message: "LENS-123. Adds awesome feature to lens. (Jaideep Dhok via amareshwari)"
-
-+---+
-
   * Keep yourself as committer and the contributor as the author of the commit.
 
 +---+
 
-    git commit -a --author "Amareshwari Sriramadasu <am...@apache.org>"
+  git commit -a --author "Amareshwari Sriramadasu <am...@apache.org>" -m "LENS-123 : Adds awesome feature to lens."
 
 +---+
 
@@ -106,6 +128,20 @@ Committer Guide
   * Add appropriate release note about what the issue is fixing. New features should have elaborate release note on
   how to use the feature.
 
+
+* Reverting a commit
+
+  * In case you messed up your first commit - you should post a revert commit to cancel the commit by a reverse patch
+   and then post a new commit with appropriate changes.
+
++---
+
+git revert HEAD~1..HEAD # To revert 1 commit.
+or,
+git revert a4r9593432 # To revert particular commit by commit id.
+
++---
+
 * Backporting patches
 
   Once the patch is pushed to master, it can be cherry-picked and applied on other major version lines.