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

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

View file

@ -11,8 +11,8 @@ une [Pull Request](https://git.kennel.ml/ConfrerieDuKassoulait/Botanique/pulls).
## Sommaire <!-- omit in toc -->
- [Recevoir de l'aide](#recevoir-de-laide)
- [Langues](#langues)
- [Ajouter une langue](#ajouter-une-langue)
- [Mettre à jour une langue](#mettre-à-jour-une-langue)
- [Ajouter une langue](#ajouter-une-langue)
- [Mettre à jour une langue](#mettre-à-jour-une-langue)
- [Projet](#projet)
- [Ajouter une commande](#ajouter-une-commande)
- [Ajouter un évènement](#ajouter-un-évènement)
@ -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
la traduction.
## Soumettre ses modifications
1. 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.
- [Créez un fork](https://git.kennel.ml/repo/fork/76) et poussez
vos modifications dans ce dernier.
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
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
d'environnement, il faut penser à mettre à jour le
[`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.
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
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**
>
> `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*,
l'historique des modifications reste disponible dans
[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)).