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

Establish and Document Rules for Commit Messages and Pull Requests #62

Open
tdog191 opened this issue Jan 8, 2020 · 0 comments
Open

Comments

@tdog191
Copy link
Contributor

tdog191 commented Jan 8, 2020

To ensure that reviewers can understand commit messages and pull requests quickly, guidelines on their formats and content should be established and documented accordingly.

For commit messages, How to Write a Git Commit Message is a blog post that discusses what I consider good guidelines for commit messages:

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

Additionally, the blog post also provides an example of a commit message that lists resolved and related issue numbers at the bottom:

Resolves: #123
See also: #456, #789

Commit 042edf7 is an example of what I would consider an ideal commit message format.

For pull requests, it is important to provide a big-picture overview of what the pull request is doing in the first comment. For pull requests related to the frontend, it is also valuable to provide screenshots of new or updated UI. The first comment of #45 is what I would consider an ideal example of both of these principles.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant