whatsapp-web.js/.github/COMMIT_CONVENTION.md

Git Commit Message Convention

This is adapted from Angular's commit convention.

Messages must be matched by the following regex (case-insensitive):

/^(revert: )?(feat|fix|docs|style|refactor|perf|test|build|ci|chore|types|infra)(\(.+\))?!?: .{1,72}/i;

The commit type is case-insensitive — feat, Feat, and FEAT are all valid.

Examples

Features

Appears under "Features" header, message subheader:

feat(message): add 'downloadMedia' option

Additional examples:

feat(chat): add ability to pin messages

feat(contact): add getProfilePicUrl method

Bug Fixes

Appears under "Bug Fixes" header, client subheader, with a link to issue #28:

fix(client): stop client breaking when QR code expires

Closes #28

Additional examples:

fix(message): handle media messages without caption correctly

fix(auth): resolve authentication timeout on slow connections

Performance Improvements

Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:

perf(message): remove legacyMode option

BREAKING CHANGE: The legacyMode option has been removed. The new message handling is always used for performance reasons.

Additional example:

perf(client): optimize event listener registration

Documentation

docs(readme): update installation instructions

docs(api): add examples for message reactions

Code Refactoring

refactor(client): simplify authentication flow

refactor(structures): extract common message properties

Tests

test(message): add unit tests for media download

test(client): add integration tests for reconnection

Build System

build(deps): update puppeteer to v21.0.0

build(webpack): optimize bundle size

Continuous Integration

ci(actions): add automated release workflow

ci(tests): run tests on multiple node versions

Chores

chore(gitignore): ignore .vscode directory

chore(deps): bump dependencies to latest versions

Type Definitions

types(message): add missing type for MessageMedia

types(client): improve ClientOptions interface

Code Style

style(client): fix indentation and spacing

Reverts

The following commit and commit 667ecc1 do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header:

revert: feat(message): add 'downloadMedia' option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

A commit message consists of a header, body and footer. The header has a type, scope and subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Revert

If the commit reverts a previous commit, it should begin with revert:, followed by the header of the reverted commit. In the body, it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

If the prefix is feat, fix or perf, it will appear in the changelog. However if there is any BREAKING CHANGE, the commit will always appear in the changelog.

Other prefixes are up to your discretion. Suggested prefixes are build, ci, docs, style, refactor, and test for non-changelog related tasks.

Scope

The scope could be anything specifying place of the commit change. For example client, message, chat, contact, media, auth, etc...

Subject

The subject contains succinct description of the change:

• use the imperative, present tense: "change" not "changed" nor "changes"
• don't capitalize first letter
• no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

A detailed explanation can be found in this document.