Skip to content
This repository was archived by the owner on Sep 22, 2025. It is now read-only.

Commit d5b6d52

Browse files
committed
docs: edit CONTRIBUTING file
edit CONTRIBUTING file to mention the commit message format
1 parent 6c1caf0 commit d5b6d52

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,13 @@ We follow the [conventional commits specification](https://www.conventionalcommi
6868
- `test`: adding or updating tests, e.g. add integration tests using detox.
6969
- `chore`: tooling changes, e.g. change CI config.
7070

71+
If your changes introduce any breaking changes, make sure to specify 'BREAKING CHANGE' in the footer of your commit message. Refer to [commit message format](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format) for more details.
72+
73+
Some guidelines to follow when writting commit messages:
74+
- use the present tense. For example, write: 'add new component' instead of 'added new component'
75+
- provide a message body that explains the changes you have made and why they are needed
76+
- provide a message footer when your change is a BREAKING CHANGE
77+
7178
Our pre-commit hooks verify that your commit message matches this format when committing.
7279

7380
When committing, you can use the 'commit' script to help you write your commit message
@@ -83,9 +90,9 @@ We use [ESLint](https://eslint.org/) with [Prettier](https://prettier.io/) for l
8390

8491
Our pre-commit hooks verify that the linter and tests pass when committing.
8592

86-
### Publishing to npm
93+
### Release Process: Release Notes & Package Publishing to npm
8794

88-
We use [semantic-release](https://github.com/semantic-release/semantic-release) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.
95+
We use [semantic-release](https://github.com/semantic-release/semantic-release) to make it easier to release new versions. [semantic-release](https://github.com/semantic-release/semantic-release) handles common tasks like bumping version based on semver, creating tags and releases etc. This is why when writting commit messages, it is a must to follow the commit message convention described above.
8996

9097
To publish new versions, run the following:
9198

0 commit comments

Comments
 (0)