Selaa lähdekoodia

docs(contributing): fix BC-break documentation

tags/v0.4.0
Jérôme Deuchnord 6 vuotta sitten
vanhempi
commit
0786a42d35
No known key found for this signature in database GPG Key ID: BC6F3C345B7D33B0
1 muutettua tiedostoa jossa 3 lisäystä ja 1 poistoa
  1. +3
    -1
      CONTRIBUTING.md

+ 3
- 1
CONTRIBUTING.md Näytä tiedosto

@@ -39,10 +39,12 @@ The commit messages of this project follow the [Conventional Commits Specificati
- **`feat: `** if your changes add a new feature. - **`feat: `** if your changes add a new feature.


The message of your commit must start with a lowercase. The message of your commit must start with a lowercase.
Finally, if your change introduce a BC-break, add an exclamation mark (`!`) before the colon.
Finally, if your change introduce a BC-break, add a footer beginning with `BREAKING CHANGE:` and explaining precisely the BC-break.


Once your PR is ready to review, please squash your commits so it contains only one commit. Once your PR is ready to review, please squash your commits so it contains only one commit.


> To ensure your commits follow this convention, you can use [glint](https://github.com/brigand/glint).

The commit messages are then used to generate the changelog using [`conventional-changelog`](https://github.com/conventional-changelog/conventional-changelog): The commit messages are then used to generate the changelog using [`conventional-changelog`](https://github.com/conventional-changelog/conventional-changelog):


```bash ```bash


Ladataan…
Peruuta
Tallenna