[Csnd-dev] PSA: Commit Messages

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view

[Csnd-dev] PSA: Commit Messages

Steven Yi
Hi All,

I'd like to ask that you please be careful about commit messages. I'm
seeing a number of "No comment" messages and other messages which are
a bit cryptic (see https://github.com/csound/csound/commits/develop).

I'd also mention that if you add a reference to the github issue in
the message, the commit gets automatically referenced in the issue
tracker for that issue. It's as simple as adding #issue-number to the
message. (see https://help.github.com/articles/autolinked-references-and-urls/#issues-and-pull-requests)