cz-ls-commits

Commitizen LawnStarter Config

Read more about LawnStarter commit message standard here.

Installation

yarn add --dev cz-ls-commits

Usage

Configure Commitizen to use this adapter:

{
  "config": {
    "commitizen": {
      "path": "cz-ls-commits"
    }
  }
}

Or use it via CLI:

npx cz-ls-commits

Making a Release

This project uses semantic-release for automated releases to npm and GitHub.

How to Release

1. Make sure your changes are committed using Conventional Commits format (using yarn cm or npx cz to create commits):

   <type>(<scope>): <description>
   
   [optional body]
   
   [optional footer(s)]

   Types: feat, fix, docs, style, refactor, test, chore, revert

   Example:

   feat: add new validation rule
   
   Added validation for commit message length
   Closes #123

2. Create a Pull Request to merge your changes into the master branch.

3. Semantic-release will automatically:

   • Analyze your commits
   • Determine the next version number
   • Create a GitHub release
   • Publish to npm

Release Types

| Commit Message | Release Type | |----------------|---------------| | fix: ... | Patch Release | | feat: ... | Minor Release | | perf: ... | Minor Release | | BREAKING CHANGE: ... | Major Release |

Manual Release (if needed)

npx semantic-release

Note: Semantic-release requires NPM_TOKEN and GITHUB_TOKEN environment variables to be set for publishing.