Explorar el Código

docs(contributing): fix BC-break documentation

tags/v0.4.0
Jérôme Deuchnord hace 6 años
padre
commit
0786a42d35
No se encontró ninguna clave conocida en la base de datos para esta firma ID de clave GPG: BC6F3C345B7D33B0
Se han modificado 1 ficheros con 3 adiciones y 1 borrados
  1. +3
    -1
      CONTRIBUTING.md

+ 3
- 1
CONTRIBUTING.md Ver fichero

@@ -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


Cargando…
Cancelar
Guardar