hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sean Busbey (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HBASE-4593) Design and document the official procedure for posting patches, commits, commit messages, etc. to smooth process and make integration with tools easier
Date Wed, 13 Aug 2014 15:06:13 GMT

    [ https://issues.apache.org/jira/browse/HBASE-4593?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14095567#comment-14095567
] 

Sean Busbey commented on HBASE-4593:
------------------------------------

Overall, LGTM. Couple of minor adjustments below:

{noformat}
+            <section xml:id="maven.build.commands.unitall">
+                <title>Running all or individual Unit Tests</title>
+                <para>See the <xref linkend="hbase.unittests.cmds"/> section
above in <xref
+                        linkend="hbase.unittests"/></para>
+            </section>
{noformat}

This is in 18.4.1.2 now, and unit tests are now in 18.9.2/3, so this should be "below" rather
than "above". Also, it looks like "running tests" is no longer a subsection of "unittests",
so this may need to be rephrased.

{noformat}
+        <title>Releasing Apache HBase</title>
+        <formalpara>
+            <title>Building against HBase 1.x</title>
+            <para>HBase 1.x requires Java 7 to build. See <xref linkend="java"/>
for Java
+                requirements per HBase release.</para>
+        </formalpara>
{noformat}

Is this meant to be a note callout?

{noformat}
+            <section xml:id="common.patch.feedback">
+                <title>Code Formatting Conventions</title>
{noformat}

The entries in here end up at section-depth 5. Would this read better if we moved all of them
up into Code Standards? They'd be at section-depth 4, and we could just add a sentence to
the intro on contributing patches that says "make sure you follow the code standards" with
a link.

> 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
>
>
> 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)

Mime
View raw message