Skip to content
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

Merged
merged 3 commits into from
Apr 4, 2017
Merged

Commit Message Guidelines #963

merged 3 commits into from
Apr 4, 2017

Conversation

meatballs
Copy link
Member

No description provided.

Copy link
Member

@drvinceknight drvinceknight left a 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/>`
Copy link
Member

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
Copy link
Member

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.

@eric-s-s
Copy link
Contributor

eric-s-s commented Apr 3, 2017

@meatballs thank you for providing this. Never even thought about it before.

@marcharper marcharper merged commit d29c198 into master Apr 4, 2017
@meatballs meatballs deleted the commits branch July 20, 2017 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants