https://github.com/single-spa/heeler

https://github.com/single-spa/heeler

Last synced: 11 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/single-spa/heeler
• Owner: single-spa
• License: mit
• Created: 2025-07-26T02:54:47.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2025-08-16T20:27:02.000Z (11 months ago)
• Last Synced: 2025-08-16T22:13:00.301Z (11 months ago)
• Language: JavaScript
• Size: 43 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# heeler

heeler is a changelog management library that asks the developer to specify whether a commit is breaking, feature, or patch, during a pre-commit hook.

## Installation

```sh

pnpm i --save-dev heeler

```

## Usage

Contributors to a project should run `pnpm exec heeler add` to create a changelog file for their contributions.

When publishing, run the `pnpm exec heeler prep` command beforehand to update the CHANGELOG.md to have the correct version number and messages.