[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
Re: [xtext-dev] Suggestion for check-in comments
|
Moritz,
pretty cool!
can the commit log be adjusted? There are some things which I
discovered:
1) rendering of whitespace is broken: see e.g. http://git.softeys.de/tmf.xtext.git/commit/7953ff025811e5842a17d59dbb5c5594e27116ce
or http://git.softeys.de/tmf.xtext.git/commitdiff/d57e448f25036ba18a90fe89c04ba3c9688124b0
2) Bug URLS are not clickable (clicking on a description takes me to
the commit description)
Cheers,
Peter
On 08.07.2009, at 10:59, Moritz Eysholdt wrote:
Hi,
+1 for Peters suggestion. This would make the Commitlog (http://git.softeys.de/tmf.xtext.git/shortlog
) much more readable.
Patterns like this would be fine for me as well:
fix ${task.key}: ${task.description}
feature ${task.key}: ${task.description}
[${task.key}] ${task.description}
cheers,
Moritz
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
_______________________________________________
xtext-dev mailing list
xtext-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/xtext-dev