Package Exports

conventional-changelog-evelyn

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (conventional-changelog-evelyn) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Conventional Changelog Evelyn

Conventional Changelog and Semantic Release presets for my projects

Description

Looking for a Semantic Release and Conventional Changelog configuration that allows for permissive types and scopes to generate nice changelog files with emoji?

Based off of the ESLint commit convention, I threw in extra types so you can load up your git client and type just about anything valid.

Example Commits

Chore: Did a thing that is not user-facing
New: Added a feature
Update: Iterated on a feature
Breaking: Changed the default behavior

Example Changelog

View CHANGELOG.md to see all of the emojis and sorting of commits in action!

Installation

# Install all of the things
npm install --save-dev @commitlint/prompt @semantic-release/changelog @semantic-release/git commitlint husky semantic-release conventional-changelog-evelyn

Usage

Husky

To enforce the commit convention locally using Husky v6, add the following hook.

npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

Package

To set up commitlint, commitizen, and semantic-release, add the following to your package.json file.

{
  "commitlint": {
    "extends": "./node_modules/conventional-changelog-evelyn/commitlint.config.js"
  },
  "config": {
    "commitizen": {
      "path": "@commitlint/prompt"
    }
  },
  "release": {
    "extends": "conventional-changelog-evelyn/release.config.js"
  }
}