[
https://issues.apache.org/jira/browse/HBASE-4593?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14090151#comment-14090151
]
Andrew Purtell commented on HBASE-4593:
---------------------------------------
Fantastic draft!
In addition to Sean's comments above:
---
In 18.4. Building Apache HBase, we should also describe a developer can build
themselves a tarball without going through the whole release procedure. I use
{noformat}
mvn -DskipTests clean install && mvn -DskipTests package assembly:single
{noformat}
The distribution tarball can be found at
{{hbase-assembly/target/hbase-<version>-bin.tar.gz}}
---
Procedure 18.2. Release Procedure, step 1 says "Update the CHANGES.txt file"
but this is also about updating POMs as well as CHANGES.txt.
---
Elsewhere in the release procedure instructions, the 'MAVEN_OPTS="-Xmx3g"'
appearing in example commands is an artifact of a Mac OS X environment. This
isn't needed on Linux in my experience. We could remove the MAVEN_OPTS here and
put in a footnote instead.
---
In 18.12.1. Create Patch, "If you need to revise your patch, leave the previous
patch file(s) attached to the JIRA, and upload the new one with a revision ID."
This isn't strictly necessary. JIRA will sort files with the same name
descending by date.
---
18.12.2. Unit Tests
Perhaps after this add a section 'Integration Tests'.
"Significant new features should provide an integration test in addition to
unit tests, suitable for exercising the new feature at different points in its
configuration space." Or something like that?
---
Will make another pass later. So much material.
> Design and document the official procedure for posting patches, commits,
> commit messages, etc. to smooth process and make integration with tools easier
> -------------------------------------------------------------------------------------------------------------------------------------------------------
>
> Key: HBASE-4593
> URL: https://issues.apache.org/jira/browse/HBASE-4593
> Project: HBase
> Issue Type: Task
> Components: documentation
> Reporter: Jonathan Gray
> Assignee: Misty Stanley-Jones
> Attachments: HBASE-4593.patch, HBASE-4593.pdf
>
>
> I have been building a tool (currently called reposync) to help me keep the
> internal FB hbase-92-based branch up-to-date with the public branches.
> Various inconsistencies in our process has made it difficult to automate a
> lot of this stuff.
> I'd like to work with everyone to come up with the official best practices
> and stick to it.
> I welcome all suggestions. Among some of the things I'd like to nail down:
> - Commit message format
> - Best practice and commit message format for multiple commits
> - Multiple commits per jira vs. jira per commit, what are the exceptions and
> when
> - Affects vs. Fix versions
> - Potential usage of [tags] in commit messages for things like book, scripts,
> shell... maybe even whatever is in the components field?
> - Increased usage of JIRA tags or labels to mark exactly which repos a JIRA
> has been committed to (potentially even internal repos? ways for a tool to
> keep track in JIRA?)
> We also need to be more strict about some things if we want to follow Apache
> guidelines. For example, all final versions of a patch must be attached to
> JIRA so that the author properly assigns it to Apache.
--
This message was sent by Atlassian JIRA
(v6.2#6252)
