commit-messages-guide
commit-messages-guide copied to clipboard
Improvements
I really like the guide, it is really complete and I would like to link it from some of my projects. I think there is still place for some improvements.
Some things taken from https://github.com/erlang/otp/wiki/writing-good-commit-messages:
- Always leave the second line blank.
- Don't end the summary line with a period - it's a title and titles don't end with a period.
Some others:
- Add a commit description, there is normally something else useful to add.
- Include the issue you are fixing to make use of Github feature to close them automatically
This are also standard thing, so would be great to add them. Are you up for a PR? I have the felling that every of us is writing is own commit guide in his projects, while we could have one general one. At the end we all write the same things. It would be nice to have some kind of community guide. It would be better and it will save all of us time. :wink:
Hi, @Ana06, thanks for your feedback, I really appreciate it! Feel free to link this guide anywhere.
I'll add these things you pointed out. Also, thanks for the erlang wiki link, it has some nice guidelines and good references (I think we may take some from http://who-t.blogspot.com.br/2009/12/on-commit-messages.html too).
I've also had the feeling that all of us are constantly writing and saying the same things separately, hope this guide saves us time and be a nice and welcoming guide to everyone 😃