@pragmatics/conventional-changelog-preset

Conventional changelog preset based on Angular commit message guidelines.

As opposed to the Angular preset, when bumping a version, this preset will always generate the appropriate changelog entries.

Summary

• Getting Started
• Built With
• Contributing
• Versioning
• Authors
• License
• Acknowledgments

Getting started

Installation

yarn add @pragmatics/conventional-changelog-preset -D

Usage

Use the Conventional Changelog CLI Quick Start with the -p conventionalcommits option.

Lerna

When using with lerna version Set the --changelog-preset flag.

$ lerna version --conventional-commits --changelog-preset @pragmatics/preset

When using lerna.json, set the following:

{
  "command": {
    "version": {
      "conventionalCommits": true,
      "changelogPreset": "@pragmatics/preset"
    }
  }
}

Lerna automatically evaluates & prepends conventional-changelog- to the preset, so node module resolution resolves to the correct package.

Commit messages

This preset follows message formats as described in commitlint/config-conventional

Supported Commit Types

• feat: A new feature
• fix: A bug fix
• perf: A code change that improves performance
• revert: Reverts a previous commit
• docs: Documentation only changes
• style: Changes that do not affect the meaning of the code (like linter changes)
• refactor: A code change that neither fixes a bug nor adds a feature
• test: Adding missing tests or correcting existing tests
• build: Changes that affect the build system or external dependencies
• ci: Changes to our CI configuration files and scripts
• chore: Other changes that don't modify source or test files

Built With

• Webstorm - for development
• Github - for versioning and deployment
• Contributor Covenant - for the Code of Conduct
• Creative Commons - to choose the license

Contributing

Please read CONTRIBUTING.md for details on our the process for submitting issues and pull requests to us. This repository has a code of conduct, we will remove things that do not respect it.

Versioning

We use SemVer for versioning. For the available versions, see the tags on this repository.

Authors

See the list of contributors who participated in this project.

License

This project is licensed under the ISC License.

Acknowledgements

The following guidelines, methodologies and architectures have been used as inspiration for this package:

• Conventional changelog Angular preset