+1. I think we've been using close to this format, but with "LIVY-XXX."
instead of "[LIVY-XXX]". I can include a copy of this Contributing section
in my next update to the livy website if we want, I almost added something
similar in my first update, but decided not to since it hadn't been
discussed yet.
Alex Bozarth
Software Engineer
Spark Technology Center
E-mail: [email protected]
GitHub: github.com/ajbozarth
505 Howard
Street
San Francisco, CA
94105
United
States
From: Marcelo Vanzin <[email protected]>
To: [email protected]
Date: 07/20/2017 01:12 PM
Subject: Re: Commit style best practices, was Re: incubator-livy-website
git commit: Fix bug in merge_livy_pr.py because
incubator-livy-website repo has no branch it's name started
with "branch-"
+1. Bad commit messages are one of my pet peeves. Although I like
periods at the end of sentences.
On Thu, Jul 20, 2017 at 1:09 PM, Luciano Resende <[email protected]>
wrote:
> Could we try to follow some best practices on PR title, commit message,
etc?
>
> Some info from: http://bahir.apache.org/contributing/#Creating+a+Pull+
> Request
>
> - Open a pull request against the master branch
>
> - The PR title should be of the form [LIVY-xxxx] Title, where
LIVY-xxxx
> is the relevant JIRA number and Title may be the JIRA’s title or a
more
> specific title describing the PR itself.
> - If the pull request is still a work in progress, and so is not ready
> to be merged, but needs to be pushed to Github to facilitate review,
then
> add [WIP] after the component.
> - For website work, a JIRA is not required
>
> - Follow The 7 rules for a great commit message
> <http://chris.beams.io/posts/git-commit/>
>
> - Separate subject from body with a blank line
> - Limit the subject line to 50 characters
> - Capitalize the subject line
> - Do not end the subject line with a period
> - Use the imperative mood in the subject line
> - Wrap the body at 72 characters
> - Use the body to explain what and why vs. how
>
> Below is an example of a good commit message
>
> [LIVY-001] Performance enhancements for decision tree
>
> Generate Matrix with random values through local memory
> if there is sufficient memory.
>
>
>
> Thoughts ?
>
> On Thu, Jul 20, 2017 at 1:03 PM, <[email protected]> wrote:
>
>> Repository: incubator-livy-website
>> Updated Branches:
>> refs/heads/master 27348bab6 -> 572b37b1e
>>
>>
>> Fix bug in merge_livy_pr.py because incubator-livy-website repo has no
>> branch it's name started with "branch-"
>>
>>
>> Project: http://git-wip-us.apache.org/repos/asf/incubator-livy-websit
>> e/repo
>> Commit: http://git-wip-us.apache.org/repos/asf/incubator-livy-websit
>> e/commit/572b37b1
>> Tree: http://git-wip-us.apache.org/repos/asf/incubator-livy-websit
>> e/tree/572b37b1
>> Diff: http://git-wip-us.apache.org/repos/asf/incubator-livy-websit
>> e/diff/572b37b1
>>
>> Branch: refs/heads/master
>> Commit: 572b37b1efc2a2947272790261b6ba023ec53b74
>> Parents: 27348ba
>> Author: jerryshao <[email protected]>
>> Authored: Thu Jul 20 13:02:23 2017 -0700
>> Committer: jerryshao <[email protected]>
>> Committed: Thu Jul 20 13:03:22 2017 -0700
>>
>> ----------------------------------------------------------------------
>> merge_livy_pr.py | 2 +-
>> 1 file changed, 1 insertion(+), 1 deletion(-)
>> ----------------------------------------------------------------------
>>
>>
>> http://git-wip-us.apache.org/repos/asf/incubator-livy-websit
>> e/blob/572b37b1/merge_livy_pr.py
>> ----------------------------------------------------------------------
>> diff --git a/merge_livy_pr.py b/merge_livy_pr.py
>> index b527a29..7296aef 100755
>> --- a/merge_livy_pr.py
>> +++ b/merge_livy_pr.py
>> @@ -359,7 +359,7 @@ def main():
>> original_head = get_current_ref()
>>
>> branches = get_json("%s/branches" % GITHUB_API_BASE)
>> - branch_names = filter(lambda x: x.startswith("branch-"), [x['name']
>> for x in branches])
>> + branch_names = [x['name'] for x in branches]
>> # Assumes branch names can be sorted lexicographically
>> latest_branch = sorted(branch_names, reverse=True)[0]
>>
>>
>>
>
>
> --
> Luciano Resende
> http://twitter.com/lresende1975
> http://lresende.blogspot.com/
--
Marcelo
