RE: standard form for commit messages
Hi, Can it be documented somewhere in m1/m2 sites ? Committers, can you try to follow it ? :-) I took a look at recent commits and it's not really used !! Arnaud Hi, I've noticed a few things going into commit messages, for which I usually use a standard form (that matches a template that used to exist in Apache's CVS). Basically, wehere applicable: PR: issue1, issue2 (using issue keys from JIRA, not URLs) Submitted by: (when it was a patch, put that persons name there) Reviewed by: (not sure if this is useful, but was in the template - who reviewed it) comment What do folks think of using this? I just find it a bit easier to parse when scanning, and also as we move to get JIRA including all our commits linked in issues the first part is especially helpful. Just a thought... don't know if we can have a template for SVN commit messages like CVS though. - Brett - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: standard form for commit messages
Yes, its already under the guide for contributing. - Brett Arnaud HERITIER wrote: Hi, Can it be documented somewhere in m1/m2 sites ? Committers, can you try to follow it ? :-) I took a look at recent commits and it's not really used !! Arnaud Hi, I've noticed a few things going into commit messages, for which I usually use a standard form (that matches a template that used to exist in Apache's CVS). Basically, wehere applicable: PR: issue1, issue2 (using issue keys from JIRA, not URLs) Submitted by: (when it was a patch, put that persons name there) Reviewed by: (not sure if this is useful, but was in the template - who reviewed it) comment What do folks think of using this? I just find it a bit easier to parse when scanning, and also as we move to get JIRA including all our commits linked in issues the first part is especially helpful. Just a thought... don't know if we can have a template for SVN commit messages like CVS though. - Brett - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: standard form for commit messages
Ok, Thanks Brett, Arnaud -Message d'origine- De : Brett Porter [mailto:[EMAIL PROTECTED] Envoyé : lundi 14 novembre 2005 00:09 À : Maven Developers List Objet : Re: standard form for commit messages Yes, its already under the guide for contributing. - Brett Arnaud HERITIER wrote: Hi, Can it be documented somewhere in m1/m2 sites ? Committers, can you try to follow it ? :-) I took a look at recent commits and it's not really used !! Arnaud Hi, I've noticed a few things going into commit messages, for which I usually use a standard form (that matches a template that used to exist in Apache's CVS). Basically, wehere applicable: PR: issue1, issue2 (using issue keys from JIRA, not URLs) Submitted by: (when it was a patch, put that persons name there) Reviewed by: (not sure if this is useful, but was in the template - who reviewed it) comment What do folks think of using this? I just find it a bit easier to parse when scanning, and also as we move to get JIRA including all our commits linked in issues the first part is especially helpful. Just a thought... don't know if we can have a template for SVN commit messages like CVS though. - Brett - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: standard form for commit messages
Ok for me, I'll try to not forget to use it ;-) Arnaud -Message d'origine- De : Brett Porter [mailto:[EMAIL PROTECTED] Envoyé : vendredi 28 octobre 2005 03:46 À : Maven Developers List Objet : standard form for commit messages Hi, I've noticed a few things going into commit messages, for which I usually use a standard form (that matches a template that used to exist in Apache's CVS). Basically, wehere applicable: PR: issue1, issue2 (using issue keys from JIRA, not URLs) Submitted by: (when it was a patch, put that persons name there) Reviewed by: (not sure if this is useful, but was in the template - who reviewed it) comment What do folks think of using this? I just find it a bit easier to parse when scanning, and also as we move to get JIRA including all our commits linked in issues the first part is especially helpful. Just a thought... don't know if we can have a template for SVN commit messages like CVS though. - Brett - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: standard form for commit messages
On Thu, 2005-10-27 at 18:46 -0700, Brett Porter wrote: Hi, I've noticed a few things going into commit messages, for which I usually use a standard form (that matches a template that used to exist in Apache's CVS). Basically, wehere applicable: PR: issue1, issue2 (using issue keys from JIRA, not URLs) Submitted by: (when it was a patch, put that persons name there) Reviewed by: (not sure if this is useful, but was in the template - who reviewed it) comment What do folks think of using this? I just find it a bit easier to parse when scanning, and also as we move to get JIRA including all our commits linked in issues the first part is especially helpful. Just a thought... don't know if we can have a template for SVN commit messages like CVS though. +1, yay standardization is it possible to get subversion to use this as a template in my editor like I think you could with CVS? -- Trygve - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: standard form for commit messages
On 28/10/05, Brett Porter [EMAIL PROTECTED] wrote: PR: issue1, issue2 (using issue keys from JIRA, not URLs) Submitted by: (when it was a patch, put that persons name there) Reviewed by: (not sure if this is useful, but was in the template - who reviewed it) comment I've always wondered what PR stood for - could anyone enlighten me?! Mark - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: standard form for commit messages
Probably the point in adding submitted by, is for submitted patches. A lot of contributors don't have commit rights so their names wouldn't show up from the SCM if you view the logs. Carlos Sanchez wrote: Sorry, when I said issue number I meant source control commit id, so when you ask for the comment used you can also get the user from the SCM On 10/27/05, Brett Porter [EMAIL PROTECTED] wrote: I think it is a good idea to include it in the SVN commit message (also a description of what was going on). It makes the source control stand on its own as a source of information. Otherwise, if you later analyse the history and it points to JIRA when we've moved on to ReallyGoodIssueTracker2010, its a bit hard to know who submitted it. - Brett Carlos Sanchez wrote: I don't see the point of including the submitted by, probably it can be obtained in any other way from the issue number. I agree with the jira issue number On 10/27/05, Brett Porter [EMAIL PROTECTED] wrote: Hi, I've noticed a few things going into commit messages, for which I usually use a standard form (that matches a template that used to exist in Apache's CVS). Basically, wehere applicable: PR: issue1, issue2 (using issue keys from JIRA, not URLs) Submitted by: (when it was a patch, put that persons name there) Reviewed by: (not sure if this is useful, but was in the template - who reviewed it) comment What do folks think of using this? I just find it a bit easier to parse when scanning, and also as we move to get JIRA including all our commits linked in issues the first part is especially helpful. Just a thought... don't know if we can have a template for SVN commit messages like CVS though. - Brett - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
standard form for commit messages
Hi, I've noticed a few things going into commit messages, for which I usually use a standard form (that matches a template that used to exist in Apache's CVS). Basically, wehere applicable: PR: issue1, issue2 (using issue keys from JIRA, not URLs) Submitted by: (when it was a patch, put that persons name there) Reviewed by: (not sure if this is useful, but was in the template - who reviewed it) comment What do folks think of using this? I just find it a bit easier to parse when scanning, and also as we move to get JIRA including all our commits linked in issues the first part is especially helpful. Just a thought... don't know if we can have a template for SVN commit messages like CVS though. - Brett - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: standard form for commit messages
I think that's ok. Since there is a Submitted by: phrase there, I assume that each patch will be committed separately. Brett Porter wrote: Hi, I've noticed a few things going into commit messages, for which I usually use a standard form (that matches a template that used to exist in Apache's CVS). Basically, wehere applicable: PR: issue1, issue2 (using issue keys from JIRA, not URLs) Submitted by: (when it was a patch, put that persons name there) Reviewed by: (not sure if this is useful, but was in the template - who reviewed it) comment What do folks think of using this? I just find it a bit easier to parse when scanning, and also as we move to get JIRA including all our commits linked in issues the first part is especially helpful. Just a thought... don't know if we can have a template for SVN commit messages like CVS though. - Brett - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: standard form for commit messages
I don't see the point of including the submitted by, probably it can be obtained in any other way from the issue number. I agree with the jira issue number On 10/27/05, Brett Porter [EMAIL PROTECTED] wrote: Hi, I've noticed a few things going into commit messages, for which I usually use a standard form (that matches a template that used to exist in Apache's CVS). Basically, wehere applicable: PR: issue1, issue2 (using issue keys from JIRA, not URLs) Submitted by: (when it was a patch, put that persons name there) Reviewed by: (not sure if this is useful, but was in the template - who reviewed it) comment What do folks think of using this? I just find it a bit easier to parse when scanning, and also as we move to get JIRA including all our commits linked in issues the first part is especially helpful. Just a thought... don't know if we can have a template for SVN commit messages like CVS though. - Brett - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: standard form for commit messages
Yes, and this is a good practice for committers anyway, to ensure changesets represent one fix or feature if possible. It makes them easier to identify later and rollback if required. -Brett Edwin Punzalan wrote: I think that's ok. Since there is a Submitted by: phrase there, I assume that each patch will be committed separately. Brett Porter wrote: Hi, I've noticed a few things going into commit messages, for which I usually use a standard form (that matches a template that used to exist in Apache's CVS). Basically, wehere applicable: PR: issue1, issue2 (using issue keys from JIRA, not URLs) Submitted by: (when it was a patch, put that persons name there) Reviewed by: (not sure if this is useful, but was in the template - who reviewed it) comment What do folks think of using this? I just find it a bit easier to parse when scanning, and also as we move to get JIRA including all our commits linked in issues the first part is especially helpful. Just a thought... don't know if we can have a template for SVN commit messages like CVS though. - Brett - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: standard form for commit messages
I think it is a good idea to include it in the SVN commit message (also a description of what was going on). It makes the source control stand on its own as a source of information. Otherwise, if you later analyse the history and it points to JIRA when we've moved on to ReallyGoodIssueTracker2010, its a bit hard to know who submitted it. - Brett Carlos Sanchez wrote: I don't see the point of including the submitted by, probably it can be obtained in any other way from the issue number. I agree with the jira issue number On 10/27/05, Brett Porter [EMAIL PROTECTED] wrote: Hi, I've noticed a few things going into commit messages, for which I usually use a standard form (that matches a template that used to exist in Apache's CVS). Basically, wehere applicable: PR: issue1, issue2 (using issue keys from JIRA, not URLs) Submitted by: (when it was a patch, put that persons name there) Reviewed by: (not sure if this is useful, but was in the template - who reviewed it) comment What do folks think of using this? I just find it a bit easier to parse when scanning, and also as we move to get JIRA including all our commits linked in issues the first part is especially helpful. Just a thought... don't know if we can have a template for SVN commit messages like CVS though. - Brett - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: standard form for commit messages
I think the reviewed-by is pointless if it's the same person as the committer. Otherwise, it matches exactly the template that I've been using so far. -Lukas Brett Porter wrote: Hi, I've noticed a few things going into commit messages, for which I usually use a standard form (that matches a template that used to exist in Apache's CVS). Basically, wehere applicable: PR: issue1, issue2 (using issue keys from JIRA, not URLs) Submitted by: (when it was a patch, put that persons name there) Reviewed by: (not sure if this is useful, but was in the template - who reviewed it) comment What do folks think of using this? I just find it a bit easier to parse when scanning, and also as we move to get JIRA including all our commits linked in issues the first part is especially helpful. Just a thought... don't know if we can have a template for SVN commit messages like CVS though. - Brett - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: standard form for commit messages
Sorry, when I said issue number I meant source control commit id, so when you ask for the comment used you can also get the user from the SCM On 10/27/05, Brett Porter [EMAIL PROTECTED] wrote: I think it is a good idea to include it in the SVN commit message (also a description of what was going on). It makes the source control stand on its own as a source of information. Otherwise, if you later analyse the history and it points to JIRA when we've moved on to ReallyGoodIssueTracker2010, its a bit hard to know who submitted it. - Brett Carlos Sanchez wrote: I don't see the point of including the submitted by, probably it can be obtained in any other way from the issue number. I agree with the jira issue number On 10/27/05, Brett Porter [EMAIL PROTECTED] wrote: Hi, I've noticed a few things going into commit messages, for which I usually use a standard form (that matches a template that used to exist in Apache's CVS). Basically, wehere applicable: PR: issue1, issue2 (using issue keys from JIRA, not URLs) Submitted by: (when it was a patch, put that persons name there) Reviewed by: (not sure if this is useful, but was in the template - who reviewed it) comment What do folks think of using this? I just find it a bit easier to parse when scanning, and also as we move to get JIRA including all our commits linked in issues the first part is especially helpful. Just a thought... don't know if we can have a template for SVN commit messages like CVS though. - Brett - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
