Commit Guide

Commit Message Format

Each commit message should start with a type, followed by a brief description. Here are the accepted types and their meanings:

Types of Commits

• feat: 🚀
  Use this when you’re adding a new feature. Examples include adding a new custom post type, a new “load more” functionality, or a webhook.

• fix: 🐛
  Use this for bug fixes. Most of the time, these will be QA items reported by a client, PM, or UX/UI team.

• style: 🎨
  Use this for commits that modify styling and layout. These should include style references like c--card-b, c--cta-a, etc.

• refactor: 🔄
  Use this for codebase refactoring. This includes changes like restructuring code, removing unnecessary classes, etc., without altering functionality.

• docs: 📚
  Use this for any changes related to documentation. This is exclusively for documentation updates.

• revert: ↩️
  Use this when reverting a previous commit. Include the commit hash and reason for the revert.

• build testing: 🧪 Use this when you want to do testing for a specific build.

Additional Description Guidelines

• Link to ClickUp
  Always include a link to the relevant ClickUp task in the commit description. This helps in tracking the task associated with the changes.

• Breaking Changes
  Breaking changes are modifications that alter existing functionality in a way that may require changes in other parts of the codebase. If your commit introduces breaking changes, mention it explicitly in the description. Clearly state what has changed and what needs to be updated elsewhere.

NOTE!

A brief description in the commit message is required. If there isn’t a ClickUp card, it’s fine to omit the link, but creating one beforehand is encouraged for documentation. Only include a “Breaking Changes” section if there are actual breaking changes.

Example Commit Messages

feat: 🚀 Add new custom post type for blog articles
Added new post type to support blog articles.
Ticket: <ClickUp task link>.
Breaking Changes: Updated routing for blog posts.

fix: 🐛 Correct alignment issue in header
Fixed header alignment on mobile view.
Ticket: <ClickUp task link>.

style: 🎨 Update c--card-b styling for consistency
Updated card style to match new design guidelines.
Ticket: <ClickUp task link>.

refactor: 🔄 Simplify API response handling logic
Refactored API response handling to improve performance and readability.
Ticket: <ClickUp task link>.

docs: 📚 Update README with new setup instructions
Updated setup instructions to include new environment variables.

revert: ↩️ Revert "feat: Add new custom post type"
Reverted previous commit due to issues with deployment. Original commit hash: `abc123`.
Ticket: <ClickUp task link>.

build testing: 🧪  Testing issue with portable text on build
Testing build on netlify with portable text
Ticket: <ClickUp task link>.