ConfrerieDuKassoulait/Botanique
ConfrerieDuKassoulait/Botanique
2
0
Fork 0
Code Issues 22 Pull requests 3 Projects 1 Releases Packages 1 Activity Actions

docs: more explanation on fork, branches and issues (#38)

Browse source 
Reviewed-on: https://git.kennel.ml/ConfrerieDuKassoulait/Botanique/pulls/38
This commit is contained in:
Anri 2022-07-26 11:31:42 +02:00
parent ab20221754
commit 962d083cbd
1 changed files with 19 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
CONTRIBUTING.md
View file

@ -135,26 +135,32 @@ Quand vous modifiez quelque chose, pensez à mettre-à-jour les langues. Si vous
ne savez pas traduire dans une langue, ne vous forcez pas, supprimer simplement ne savez pas traduire dans une langue, ne vous forcez pas, supprimer simplement
la traduction. la traduction.
## Soumettre ses modifications - [Créez un fork](https://git.kennel.ml/repo/fork/76) et poussez
1. Lorsque vous vous sentez confiant dans vos modifications, ouvrez vos modifications dans ce dernier.
une [Pull Request](https://git.kennel.ml/ConfrerieDuKassoulait/Botanique/pulls)
afin que votre code puisse être revu et fusionné. Vous pouvez suivre cette
[condition de nommage](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716#example)
ça aide à s'y retrouver plus rapidement.
Pour commencer, vous pouvez jeté un oeil aux
[`tickets facilement résolvable`](https://git.kennel.ml/ConfrerieDuKassoulait/Botanique/issues?state=open&labels=82).
## Soumettre ses modifications
1. Pensez à bien commenter votre code pour que n'importe qui comprennent vos 1. Pensez à bien commenter votre code pour que n'importe qui comprennent vos
modifications. Vérifier bien dans tout les fichiers si ce que vous avez modifications. Vérifier bien dans tout les fichiers si ce que vous avez
modifié n'est pas référencer ailleurs (exemple : si vous modifier une variable modifié n'est pas référencer ailleurs (exemple : si vous modifier une variable
d'environnement, il faut penser à mettre à jour le d'environnement, il faut penser à mettre à jour le
[`README`](./README.md#variables-denvironnements)). [`README`](./README.md#variables-denvironnements)).
3. N'oubliez pas d'utiliser [les fichiers de langues](./src/locales/) pour vos 2. N'oubliez pas d'utiliser [les fichiers de langues](./src/locales/) pour vos
chaînes de caractère, [cf. cette partie](#langues) pour plus de précisions. chaînes de caractère, [cf. cette partie](#langues) pour plus de précisions.
4. Veuillez tester vos modifications avant de les soumettre. **Attention**, ce 3. Veuillez tester vos modifications avant de les soumettre. **Attention**, ce
n'est pas parce que vos modifications fonctionnent avec `npm run debug` qu'elles n'est pas parce que vos modifications fonctionnent avec `npm run debug` qu'elles
fonctionneront avec `npm run main`, ainsi que dans l'image Docker. fonctionneront avec `npm run main`, ainsi que dans l'image Docker.
4. Lorsque vous vous sentez confiant dans vos modifications, ouvrez
une [Pull Request](https://git.kennel.ml/ConfrerieDuKassoulait/Botanique/pulls)
afin que votre code puisse être revu et fusionné. Vous pouvez suivre cette
[condition de nommage](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716#example),
ça aide à s'y retrouver plus rapidement.
> **Explication** > **Explication**
> >
> `npm run debug` execute le code depuis le dossier [`src`](src/) > `npm run debug` execute le code depuis le dossier [`src`](src/)
@ -168,3 +174,6 @@ fonctionneront avec `npm run main`, ainsi que dans l'image Docker.
- Quand on merge des modifications vers `main`, on fait un *squash*, - Quand on merge des modifications vers `main`, on fait un *squash*,
l'historique des modifications reste disponible dans l'historique des modifications reste disponible dans
[le graph](https://git.kennel.ml/ConfrerieDuKassoulait/Botanique/graph). [le graph](https://git.kennel.ml/ConfrerieDuKassoulait/Botanique/graph).
- De préférences, suivre les indications de
[ce post](https://gist.github.com/revett/88ee5abf5a9a097b4c88) (c'est un peu la
même que dans le `4.` de [la partie précédente](#soumettre-ses-modifications)).