Skip to content

Commit cb74fed

Browse files
author
Steven
committed
chore: update contributing guidelines
1 parent f02a01f commit cb74fed

File tree

1 file changed

+4
-14
lines changed

1 file changed

+4
-14
lines changed

CONTRIBUTING.md

+4-14
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,5 @@
11
## Contributing
22

3-
Development happens on the `master` branch. When a release is
4-
being prepared, it is tagged on that branch with a `vX.0.0-rc#`
5-
tag, and released to npm with the `next` tag. Typically,
6-
releases that start from the `master` branch will increase
7-
the major version number.
8-
After release, changes are continued on a `X-rel` branch.
9-
On that branch, bugfixes will increase the patch number, while
10-
backported features (that don't break the interface) will
11-
increase the minor version number.
12-
133
Please use the github issue tracker for any bugs or feature requests,
144
email sent to the maintainer(s) will probably be ignored.
155
If you would like to backport a feature from master to a release
@@ -19,10 +9,10 @@ If you would like to contribute bug fixes or new components,
199
make sure there is an existing issue for it, and make a pull
2010
request referencing the issue.
2111

22-
If your changes cause problems with how the library was used
23-
before, please write `[breaking]` att the beginning of the commit
24-
title (and pull request if applicable), and describe what has
25-
changed in the commit message.
12+
We use [conventional commits](https://www.conventionalcommits.org) to write commit messages.
13+
If your changes cause problems with how the library was used before,
14+
don't forget to write `BREAKING CHANGE:` inside the commit message body,
15+
followed by a description of what has changed and how to adapt for it.
2616

2717
Most components have unit tests, and basic proper behaviour is always
2818
tested, but we don't have full coverage (yet) of all the component code.

0 commit comments

Comments
 (0)