[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
Re: [xtext-dev] Suggestion for check-in comments
|
+1
I think it would be even better if we not just copy the subject, but
write some words about what we actually did in order to address the
referenced bugzilla.
Cheers,
Sven
On Jul 7, 2009, at 10:21 PM, Peter Friese wrote:
Hi,
I'd like to suggest we agree on a check-in comment pattern that
allows others to deduce from the comment alone what is going on in
the commit. Commits comments only consisting of the bug url do not
help much in learning what is going on. If you use myly, you could
use this pattern to additionally include the bug decription:
[${task.key}] ${task.description} - ${task.url}
Of course, it always make sense to adjust the comment when checking
in to match the change you actually performed.
Reason I'm asking: I do not have time to dig through all the
commits. However, I'd like to look into commits that are interesting
to me (e.g. because they affect an area where one of of my customers
has experienced a bug, or because I have been working on myself).
Or, just to keep up to what's happening in general - really
important for those of us who are located remotely or are on the
road. Reading the commit comments, you usually can get a good idea
of what's going on.
I am happy to discuss any commit comment template, and I am also
fine if we just add a short description manually (without using any
tooling), as long as we just do it ;-)
Cheers,
Peter
_______________________________________________
xtext-dev mailing list
xtext-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/xtext-dev
