[HBASE-4593] Design and document the official procedure for posting patches, commits, commit messages, etc. to smooth process and make integration with tools easier - ASF JIRA

Log work

Agile Board

Rank to Top

Rank to Bottom

Attach files

Attach Screenshot

Bulk Copy Attachments

Bulk Move Attachments

Voters

Watch issue

Watchers

Create sub-task

Convert to sub-task

Move

Link

Clone

Labels

Update Comment Author

Replace String in Comment

Update Comment Visibility

Delete Comments

XML

Word

Printable

JSON

Details

Type: Task
Status: Closed
Priority: Major
Resolution: Fixed
Affects Version/s: None
Fix Version/s: 2.0.0
Component/s: documentation
Labels:
None

Hadoop Flags:

Reviewed

Description

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.