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

Enforce style of commit messages #58

Open
1 of 7 tasks
Robbert opened this issue May 30, 2016 · 1 comment
Open
1 of 7 tasks

Enforce style of commit messages #58

Robbert opened this issue May 30, 2016 · 1 comment

Comments

@Robbert
Copy link
Member

Robbert commented May 30, 2016

  • End with punctuation, rather [.…] than [?!].
  • Include reference to bug tracker issue.
  • Limit first line of the message to the GitHub cutoff of 70 characters.
  • Warn to move files in separate "chore" commits.
  • Require newline between first line and other content.

Ideally the commit message equals the issue subject.

Later on:

@Robbert
Copy link
Member Author

Robbert commented Jun 2, 2016

Incomplete list of verbs a commit message (a task description) may start with...

Bug fix:

  • Fix

Feature:

  • Test
  • Verify
  • Add

Refactorings:

  • Refactor
  • Rename
  • Move
  • Remove

Configuration changes:

  • Ignore
  • Allow
  • Disallow
  • Enable
  • Disable
  • Configure

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