Re: jira reference is missing from git commit messages

[Mike Percy]

Hi Attila,

On Fri, Oct 21, 2016 at 7:51 PM, Attila Simon  wrote:

> I have no strong opinion on whether we should have a jira or not (thus
> the proposal of FLUME-PR70). I just "I found this habit very useful".
>

It seems kind of obtrusive to me to require committers to use this kind of
pattern for a PR, to be honest, when the "Closes #70" thing is already
there.

Something that Gerrit does is it automatically adds something equivalent to:

  Reviewed-on: https://github.com/apache/flume/pull/70

to the bottom of the commit message. Maybe it would be useful to have
people include this when committing PRs? However, it's particular enough
that we should probably write a shell script to automate it so committers
don't have to remember (or adapt one of the scripts used by the Spark
project, maybe).

Would that help with the problem you are facing?


> I have tooling which depends on the commit titles are unique with high
> probability. Most likely these tools can be upgraded with some extra
> effort.
>

I think we should try to make it as easy as possible for downstream
distributors to consume Flume. Still, I wonder if that tool you're using
just sucks. Let me know how I can help you deal with the downstream stuff
as I wonder if there aren't better ways of solving this problem.

Maybe having jira for each change is an overkill for small changes.
> What do you think what can be considered as a small change? eg the
> ones for which the "how to contribute" guide doesn't require review
> board?
>

In the past we have used JIRA to track patch submission, comments, and code
reviews. GitHub Pull Requests encompass all of those things, so I don't see
any reason to also use JIRA when submitting a PR, except when the PR fixes
an issue or implements a feature that has a JIRA filed against it.

I just don't see value to the project in requiring someone submitting a PR
to additionally file a JIRA. I think JIRA is mostly useful as a way to
track outstanding bugs and future work.

I know that different people have different views on this issue and I don't
want to impose my preferences on everyone working on Flume. I'd like to get
your thoughts on the above and I'd also like to hear from others on the
topic. I hope that we can standardize on a process that works well for
everyone.

Mike

Re: jira reference is missing from git commit messages

[Attila Simon]

Hi Mike,

I'm a big fan of having the site in scm so I guess I can volunteer
after Donat finishes that movement.
I have no strong opinion on whether we should have a jira or not (thus
the proposal of FLUME-PR70). I just "I found this habit very useful".
I have tooling which depends on the commit titles are unique with high
probability. Most likely these tools can be upgraded with some extra
effort.
Maybe having jira for each change is an overkill for small changes.
What do you think what can be considered as a small change? eg the
ones for which the "how to contribute" guide doesn't require review
board?

Cheers,
Attila

On Fri, Oct 21, 2016 at 12:54 PM, Mike Percy  wrote:
>
> Hi Attila,
> Thanks for raising this concern of yours. Please see inline.
>
> On Fri, Oct 21, 2016 at 12:17 PM, Attila Simon  wrote:
>
> > The how to contribute page asks to have a jira first for each change. I
> > guess with allowing pull requests we have to update the how to contribute
> > page as well (which only describes attaching patch and using review board).
> >
>
> Yes, it appeared that we had consensus for allowing PR on a couple separate
> dev@ threads a while back [1], [2].
>
> The Flume contributor docs are currently a bit stale. I have recently
> updated the How to Release cwiki page but if you want to volunteer to
> update some of the other docs that would be very welcome! Please let me
> know if you want to help and I can give you cwiki edit access if you send
> me your account id. Side note: Donat has recently proposed moving those
> docs from cwiki to the Git repo which I think would be a big improvement.
>
> I would like to ask committers to reestablish the habit of having a jira
> > for each commit and start the message with that jira.
> >
>
> Forcing people to file a JIRA when they are already doing a PR feels like
> pointless extra paperwork to me. There is certainly a place for JIRA in a
> software project, but I think that is to track unfixed bugs, ongoing tasks
> / projects, etc.
>
>
> > If we would like to relax the have jira for each change (for pull requests)
> > then I would suggest putting the request id as the first thing in the
> > commit message.
> >
>
> Why?
>
> If you click on this:
> https://github.com/apache/flume/commit/87d4c2c13862144eb578b211bcf800b2206834ff
>
> You will see that the text "Closes #70" creates a clickable hyperlink to
> the PR. Is this not sufficient for tracking purposes?
>
> Mike
>
> [1] https://s.apache.org/k31f
> [2] https://s.apache.org/Skm2

Re: jira reference is missing from git commit messages

[Mike Percy]

Hi Attila,
Thanks for raising this concern of yours. Please see inline.

On Fri, Oct 21, 2016 at 12:17 PM, Attila Simon  wrote:

> The how to contribute page asks to have a jira first for each change. I
> guess with allowing pull requests we have to update the how to contribute
> page as well (which only describes attaching patch and using review board).
>

Yes, it appeared that we had consensus for allowing PR on a couple separate
dev@ threads a while back [1], [2].

The Flume contributor docs are currently a bit stale. I have recently
updated the How to Release cwiki page but if you want to volunteer to
update some of the other docs that would be very welcome! Please let me
know if you want to help and I can give you cwiki edit access if you send
me your account id. Side note: Donat has recently proposed moving those
docs from cwiki to the Git repo which I think would be a big improvement.

I would like to ask committers to reestablish the habit of having a jira
> for each commit and start the message with that jira.
>

Forcing people to file a JIRA when they are already doing a PR feels like
pointless extra paperwork to me. There is certainly a place for JIRA in a
software project, but I think that is to track unfixed bugs, ongoing tasks
/ projects, etc.


> If we would like to relax the have jira for each change (for pull requests)
> then I would suggest putting the request id as the first thing in the
> commit message.
>

Why?

If you click on this:
https://github.com/apache/flume/commit/87d4c2c13862144eb578b211bcf800b2206834ff

You will see that the text "Closes #70" creates a clickable hyperlink to
the PR. Is this not sufficient for tracking purposes?

Mike

[1] https://s.apache.org/k31f
[2] https://s.apache.org/Skm2

jira reference is missing from git commit messages

[Attila Simon]

Hi,

Not too long ago all the messages in the git log started with the
corresponding jira. I found this habit very useful.
The how to contribute page asks to have a jira first for each change. I
guess with allowing pull requests we have to update the how to contribute
page as well (which only describes attaching patch and using review board).

I would like to ask committers to reestablish the habit of having a jira
for each commit and start the message with that jira.
If we would like to relax the have jira for each change (for pull requests)
then I would suggest putting the request id as the first thing in the
commit message.

instead of:
Author: Mike Percy 
Date:   Wed Oct 12 19:32:13 2016 +0200

Remove test dependencies from binary release artifact

This patch removes some test-specific dependencies from the binary
release artifact. These were introduced by the new
flume-shared-kafka-test module that is intended for sharing test code.
Please see the new comment in bin.xml for more information.

Reviewers: Bessenyei Balázs Donát

Closes #70


I would suggest:
Author: Mike Percy 
Date:   Wed Oct 12 19:32:13 2016 +0200

FLUME- Remove test dependencies from binary release artifact

This patch removes some test-specific dependencies from the binary
release artifact. These were introduced by the new
flume-shared-kafka-test module that is intended for sharing test code.
Please see the new comment in bin.xml for more information.

Reviewers: Bessenyei Balázs Donát

Closes #70

or the relaxed version if it is really needed to drop the jira requirement:
Author: Mike Percy 
Date:   Wed Oct 12 19:32:13 2016 +0200

FLUME-PR70 Remove test dependencies from binary release artifact

This patch removes some test-specific dependencies from the binary
release artifact. These were introduced by the new
flume-shared-kafka-test module that is intended for sharing test code.
Please see the new comment in bin.xml for more information.

Reviewers: Bessenyei Balázs Donát

Closes #70


Cheers,
Attila