-
Notifications
You must be signed in to change notification settings - Fork 263
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Commit Message Guidelines #963
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great.
3. Commits: Please try to use commit messages that give a meaningful history | ||
for anyone using git's log features. Try to use messages that complete sentence, | ||
"If merged, this commit will...." There is some excellent guidance on the subject | ||
from `Chris Beams <https://chris.beams.io/posts/git-commit/>` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe this needs a _
at the end for the url to be picked up properly?
`Chris Beams <https://chris.beams.io/posts/git-commit/>`_
3. Testing: the project uses the `unittest | ||
3. Commits: Please try to use commit messages that give a meaningful history | ||
for anyone using git's log features. Try to use messages that complete sentence, | ||
"If merged, this commit will...." There is some excellent guidance on the subject |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about "This commit <etc.>" rather than "if merged, ..." which seems redundant.
@meatballs thank you for providing this. Never even thought about it before. |
No description provided.