Security News
JSR Working Group Kicks Off with Ambitious Roadmap and Plans for Open Governance
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
conventional-changelog-eslint
Advanced tools
conventional-changelog eslint preset.
Issues with the convention itself should be reported on the ESLint issue tracker.
# yarn
yarn add -D conventional-changelog-eslint
# pnpm
pnpm add -D conventional-changelog-eslint
# npm
npm i -D conventional-changelog-eslint
Our commit message format is as follows:
Tag: Short description (fixes #1234)
Longer description here if necessary
The first line of the commit message (the summary) must have a specific format. This format is checked by our build tools.
The Tag
is one of the following:
Fix
- for a bug fix.Update
- either for a backwards-compatible enhancement or for a rule change that adds reported problems.New
- implemented a new feature.Breaking
- for a backwards-incompatible enhancement or feature.Docs
- changes to documentation only.Build
- changes to build process only.Upgrade
- for a dependency upgrade.Chore
- for refactoring, adding tests, etc. (anything that isn't user-facing).Use the labels of the issue you are working on to determine the best tag.
The message summary should be a one-sentence description of the change, and it must be 72 characters in length or shorter. If the pull request addresses an issue, then the issue number should be mentioned at the end. If the commit doesn't completely fix the issue, then use (refs #1234)
instead of (fixes #1234)
.
Here are some good commit message summary examples:
Build: Update Travis to only test Node 0.10 (refs #734)
Fix: Semi rule incorrectly flagging extra semicolon (fixes #840)
Upgrade: Esprima to 1.2, switch to using comment attachment (fixes #730)
The commit message format is important because these messages are used to create a changelog for each release. The tag and issue number help to create more consistent and useful changelogs.
Based on https://eslint.org/docs/developer-guide/contributing/pull-requests#step2
FAQs
ESLint preset for conventional-changelog.
The npm package conventional-changelog-eslint receives a total of 979,668 weekly downloads. As such, conventional-changelog-eslint popularity was classified as popular.
We found that conventional-changelog-eslint demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.