[
https://issues.apache.org/jira/browse/HBASE-4593?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14103982#comment-14103982
]
Sean Busbey commented on HBASE-4593:
------------------------------------
+1 LGTM, modulo nits below.
{noformat}
+ <listitem xml:id="submitting.patches.naming">
+ <para>The patch should have the JIRA ID in the name.
If you generating from
+ a branch, include the target branch in the
filename. A common naming
+ scheme for patches is:</para>
{noformat}
"If you are generating"
{noformat}
+ multiple attachments with the same name. However,
at times it is easier
+ to refer to different version of a patch if you add
+ <literal>_vX</literal>, where the
<replaceable>X</replaceable> is
+ the version (starting with 2).</para>
{noformat}
In the name formatting section we say to use "-vX" and here we say "_vX". They
should be consistent. I believe "-vX" is what people are currently doing.
> 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: Chapter_18_and_19.pdf, Chapter_18_and_19.pdf,
> HBASE-4593.patch, HBASE-4593.patch, HBASE-4593.patch, HBASE-4593.patch,
> HBASE-4593.patch
>
>
> 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)
