Hi,
I've been preparing the release notes for Servicecomb lately, and I have
found the following problems:
1. The commit messages are not clear
The commit messages should have a concise and clear headline describing
what the commit changed followed by a detailed body explaining why and how,
and other necessary information. Most of the commit messages are unclear
and does not have a body.
Please read this article for how to write a commit message:
https://chris.beams.io/posts/git-commit/
2. The PR messages are not clear
There is a rule in checklist for the PR states 'Each commit in the pull
request should have a meaningful subject line and body'. But few of us
followed.
For simple changes, the commit message is enough to be used as PR
message. For more complicated changes, we should provide more information.
3. The issues in the Jira system are not clear.
4. The issue tags are not correctly used in jira.
Changes that introduce new functionality can be tagged as feature.
Changes only affect internal API should be marked as improvement.
For tasks, we should also mark it as one of the following:
feature/improvement/bugfix.
Clear commit messages and PR messages is a critical part of an open-source
project. Because only with a clear history log, new developers can get the
information they are interested in without repeated direct communication
with us.
--
Best Regards,
Yang.
