Skip to content

Commit

Permalink
Ajoute une section dans le CONTRIBUTING pour introduire le CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
Allan-CodeWorks committed Aug 16, 2023
1 parent 295b46b commit 8353ff6
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ Certaines règles sont communes à tous les dépôts OpenFisca et sont détaill

## Gestion sémantique de version

Le niveau des évolutions d'OpenFisca-France-Local doivent pouvoir être comprises par des réutilisateurs qui n'interviennent pas nécessairement sur le code.
Le niveau des évolutions d'OpenFisca-France-Local doivent pouvoir être comprises par des réutilisateurs qui n'interviennent pas nécessairement sur le code.

Un numéro de version doit donc être attribué à toute évolution intégrée sur la branche principale `master` (par la mise à jour du fichier `setup.py`). Ses règles d'incrémentation suivent les principes du versionnement sémantique détaillés dans [la documentation générale](https://openfisca.org/doc/contribute/semver.html).

## Formalisation du CHANGELOG

Chaque version donne lieu à une description des changements qu'elle apporte dans le fichier `CHANGELOG.md`, fichier qui respecte le standard [Common Changelog](https://common-changelog.org).

La syntaxe à utiliser pour une entrée valide est détaillée dans [le wiki](https://github.com/openfisca/openfisca-france-local/wiki/Ajouter-une-entr%C3%A9e-dans-le-CHANGELOG).

Chaque Pull Request acceptée sur la branche principale déclenche le déploiement d'une nouvelle version.

0 comments on commit 8353ff6

Please sign in to comment.