accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r1491667 - /accumulo/site/branches/git/content/git.mdtext
Date Tue, 11 Jun 2013 01:14:58 GMT
Author: elserj
Date: Tue Jun 11 01:14:57 2013
New Revision: 1491667

ACCUMULO-1498 Stub out the major-release section and start lifting some info from the Kafka


Modified: accumulo/site/branches/git/content/git.mdtext
--- accumulo/site/branches/git/content/git.mdtext (original)
+++ accumulo/site/branches/git/content/git.mdtext Tue Jun 11 01:14:57 2013
@@ -109,9 +109,45 @@ identifying attributes but the same cont
 ## Contributors
-Follow the [simple contributor
-from Apache Kafka's website.
+Use the following steps, original derived from Apache Kafka's [simple contributor
+To be specific, let's consider a contributor wanting to work on a fix for the
+Jira issue ACCUMULO-12345 that affects 1.5.0 release.
+1. Ensure you configured Git with your information
+    `git config --global 'My Name'`
+    `git config --global ''`
+2. Clone the Accumulo repository:
+    `git clone accumulo`
+3. or update your local copy:
+    `git fetch && git fetch --tags`
+4. For the given issue you intend to work on, choose the 'lowest' fixVersion
+and create a branch for yourself to work in.
+    `git checkout -b ACCUMULO-12345-my-work origin/1.5.1-SNAPSHOT`
+5. Make commits as you see fit as you fix the issue, referencing the issue name
+in the commit message:
+    `git commit -av`
+6. Assuming others are developing against the version you also are, as you
+work, or before you create your patch, rebase your branch against the remote to
+lift your changes to the top of your branch.
+    `git pull --rebase origin 1.5.1-SNAPSHOT`
+7. At this point, you can create a patch file from the upstream branch to attach
+to the ACCUMULO-12345 Jira issue.
+    `git format-patch 1.5.1-SNAPSHOT --stdout > ACCUMULO-12345.patch`
 In a nutshell, contributors should make their changes against the version in
 which the fix is intended, `git-rebase`'ing their changes against the upstream
@@ -193,7 +229,21 @@ named something like `x.y.z'-RC-N`.
 ### A major release
+A major release is a release in which multiple new features are introduced
+and/or the public API are modified. The major release `y\'`, even when the
+client API is not modified, will typically contain many new features and
+functionality above the last release series 'y'. A major release also resets the
+`z` value back to `0`.
+The steps to create a new major release are very similar to a minor release:
+1. Prepare the release candidate. _reference release instructions_
+2. Create a tag of the release candidate from the `x.y.0'-SNAPSHOT` branch,
+named something like `x.y.0-RC-N`.
+3. Test and Vote
+4. Create a tag with the correct final name: `x.y.0`
+5. Push a delete of the remote branch `x.y.z'-SNAPSHOT` (_this should be fine
+   with ASF policy since the history is still intact_)
 # The infrastructure

View raw message