Skip to content

Commit 668508d

Browse files
committed
docs(CONTRIBUTING): adds contributing guidelines
Adds a CONTRIBUTING.md file with guidelines for contributing to the project. This includes instructions for creating feature/fix branches, creating release branches, updating version numbers in relevant files, and deploying new releases.
1 parent f461121 commit 668508d

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contribuer
2+
3+
## Créer une nouvelle fonctionnalité ou un correctif
4+
5+
À partir de la branche `develop` à jour, créez votre branche `feature/<topic>` si c'est une nouvelle fonctionnalité ou `fix/<topic>` si c'est un correctif.
6+
7+
## Merger votre fonctionnalité ou correctif
8+
9+
Créez une Pull Request de votre branche vers `main`.
10+
11+
## Créer une nouvelle branche de release
12+
13+
Une fois votre branche mergée sur `main`, créez une nouvelle branche `release/X.X.X` (X.X.X correspondant à la nouvelle version de votre release).
14+
15+
Modifiez les fichiers `.plugin-data` et `beapi-acf-palette.php` pour mettre à jour la version.
16+
17+
```plain
18+
{
19+
"version": "1.0.6",
20+
"slug": "beapi-acf-palette"
21+
}
22+
```
23+
24+
```php
25+
/*
26+
Version: 1.0.6
27+
*/
28+
29+
define( 'BEAPI_ACF_PALETTE_VERSION', '1.0.6' );
30+
```
31+
32+
Committez et poussez votre branche.
33+
34+
## Déployer une nouvelle release
35+
36+
Créez une Pull Request de votre branche `release/X.X.X` vers `main` et une autre Pull Request vers `develop`.
37+
38+
Une fois validée et mergée, un nouveau tag sera créé. Il faudra ensuite lancer la commande Satis pour mettre à jour <https://composer.beapi.fr/>.

0 commit comments

Comments
 (0)