Commit Message Best Practices

  • Use the imperative mood: e.g., Add feature, Fix bug, Refactor method, instead of Added or Adding.
  • Keep the subject line under 50 characters.
  • Capitalize the subject line.
  • Do not end the subject line with a period.
  • Use the body to explain what and why, not how.
  • Wrap the body at 72 characters per line for readability.
  • Reference issues or tickets when relevant.

Example:

Add error handling for API failures

Refactors the request handler to catch timeouts and HTTP 500 errors.
Logs all failures to Sentry for tracking. Related to #245.