Commit Message Conventions 📝

Subject Line

• Start with a clear, imperative subject line.
• Example: "Add user authentication."

Capitalization and Punctuation

• Capitalize the first word.
• Avoid ending the subject line with a period.

Reference Linear Tickets

• Include the Linear ticket ID in the commit message to link commits with specific tasks.
• Format: [Ticket-ID] Short description of the change. (e.g., [PROJ-123] Add user authentication).

Body (Optional)

• Use the body to explain what and why you made the change.
• Leave out implementation details.

Breaking Changes

• If your commit introduces breaking changes, indicate it in the subject line (e.g., feat(api)!: remove legacy endpoint).

Wrap Lines at 72 Characters

• Keep lines concise for readability.

Commit Message Linting

• Consider using tools like Commitizen to enforce standards and sync up semantic versioning.

Integrate with Linear

• Ensure commit messages and branch names follow the required format for Linear integration to link tasks automatically.

By following these conventions, your workflow will stay organized and efficient, making it easier to track changes and collaborate effectively.