Discussion:
[mantisbt-dev] MantisBT git commit guidelines
Damien Regad
2014-05-28 08:41:04 UTC
Permalink
Hi team,

Following recent comments I made in some of Paul's recent pull requests,
I finally took the time to complete a wiki page on how to write good
commit messages I had started drafting several months ago.

http://www.mantisbt.org/wiki/doku.php/mantisbt:git_commit_messages

Please review, comments welcome.

If noone objects, I would like to propose it as a guideline for the project.

I appreciate that it takes some effort to follow this recommendation
properly, but I think it gives great maintenance and documentation
benefits in the long run so it is worth it.

D

---
This email is free from viruses and malware because avast! Antivirus protection is active.
http://www.avast.com
Damien Regad
2014-05-28 09:50:52 UTC
Permalink
@grangeway

Please note that the source integration regex fails to parse references
with a ':' after the keyword.

In other words,

DO: 'Fix #0016955: blah blah'
DON'T: 'Fix: #0016955: blah blah'

Please amend pending commit messages in open pull requests accordingly.
Post by Damien Regad
Hi team,
Following recent comments I made in some of Paul's recent pull requests,
I finally took the time to complete a wiki page on how to write good
commit messages I had started drafting several months ago.
http://www.mantisbt.org/wiki/doku.php/mantisbt:git_commit_messages
Please review, comments welcome.
If noone objects, I would like to propose it as a guideline for the project.
I appreciate that it takes some effort to follow this recommendation
properly, but I think it gives great maintenance and documentation
benefits in the long run so it is worth it.
D
---
This email is free from viruses and malware because avast! Antivirus protection is active.
http://www.avast.com
------------------------------------------------------------------------------
Time is money. Stop wasting it! Get your web API in 5 minutes.
www.restlet.com/download
http://p.sf.net/sfu/restlet
---
This email is free from viruses and malware because avast! Antivirus protection is active.
http://www.avast.com
Robert Munteanu
2014-05-29 08:19:08 UTC
Permalink
Post by Damien Regad
Hi team,
Following recent comments I made in some of Paul's recent pull requests,
I finally took the time to complete a wiki page on how to write good
commit messages I had started drafting several months ago.
http://www.mantisbt.org/wiki/doku.php/mantisbt:git_commit_messages
Please review, comments welcome.
Looks OK overall to me. I'd suggest making the point

4. Sign-off if the commit’s author is not a MantisBT core developer

a bit clearer by stating that the sign-off must be made by the
committer, not by the author.

Robert
Post by Damien Regad
If noone objects, I would like to propose it as a guideline for the project.
I appreciate that it takes some effort to follow this recommendation
properly, but I think it gives great maintenance and documentation
benefits in the long run so it is worth it.
D
---
This email is free from viruses and malware because avast! Antivirus protection is active.
http://www.avast.com
------------------------------------------------------------------------------
Time is money. Stop wasting it! Get your web API in 5 minutes.
www.restlet.com/download
http://p.sf.net/sfu/restlet
_______________________________________________
mantisbt-dev mailing list
https://lists.sourceforge.net/lists/listinfo/mantisbt-dev
--
http://robert.muntea.nu/
Damien Regad
2014-05-30 10:14:01 UTC
Permalink
Post by Robert Munteanu
4. Sign-off if the commit’s author is not a MantisBT core developer
a bit clearer by stating that the sign-off must be made by the
committer, not by the author.
I thought that was implied and kind of obvious... but anyway, clarified

https://www.mantisbt.org/wiki/doku.php/mantisbt:git_commit_messages#sign-off

---
This email is free from viruses and malware because avast! Antivirus protection is active.
http://www.avast.com
Paul Richards
2014-05-30 10:30:48 UTC
Permalink
Post by Damien Regad
Post by Robert Munteanu
4. Sign-off if the commit’s author is not a MantisBT core developer
a bit clearer by stating that the sign-off must be made by the
committer, not by the author.
I thought that was implied and kind of obvious... but anyway, clarified
https://www.mantisbt.org/wiki/doku.php/mantisbt:git_commit_messages#sign-off
---
This email is free from viruses and malware because avast! Antivirus protection is active.
http://www.avast.com
------------------------------------------------------------------------------
Time is money. Stop wasting it! Get your web API in 5 minutes.
www.restlet.com/download
http://p.sf.net/sfu/restlet
_______________________________________________
mantisbt-dev mailing list
https://lists.sourceforge.net/lists/listinfo/mantisbt-dev
Loading...