additions and updates
This commit is contained in:
parent
2d4c03f296
commit
c8f6b9645b
1 changed files with 37 additions and 11 deletions
|
@ -1,8 +1,8 @@
|
|||
# Comment contribuer ? <!-- omit in toc -->
|
||||
Ce guide contient instructions et conseils sur la façon de contribuer au projet.
|
||||
Veuillez le lire attentivement si vous êtes un nouveau contributeur.
|
||||
Ce guide contient méthodes et conseils sur comment aider le projet.
|
||||
Lisez attentivement si vous êtes un nouveau contributeur.
|
||||
|
||||
Ce guide n'est pas définitif et il est mis à jour au fil du temps. Si vous
|
||||
Ce guide n'est pas fixe et est mis à jour régulièrement. Si vous
|
||||
trouvez un problème quelconque, n'hésitez pas à le signaler par le biais
|
||||
d'un [ticket](https://git.kennel.ml/ConfrerieDuKassoulait/Botanique/issues) ou
|
||||
à le corriger directement en soumettant
|
||||
|
@ -14,7 +14,7 @@ une [Pull Request](https://git.kennel.ml/ConfrerieDuKassoulait/Botanique/pulls).
|
|||
- [Ajouter une langue](#ajouter-une-langue)
|
||||
- [Mettre à jour une langue](#mettre-à-jour-une-langue)
|
||||
- [Soumettre ses modifications](#soumettre-ses-modifications)
|
||||
- [Type de merge](#type-de-merge)
|
||||
- [Gestion du dépôt](#gestion-du-dépôt)
|
||||
|
||||
## Recevoir de l'aide
|
||||
Si tu as besoin d'aide, tu peux poser ta question sur
|
||||
|
@ -30,26 +30,52 @@ toutes les chaînes de caractère dont le bot a besoin.
|
|||
|
||||
|
||||
### Ajouter une langue
|
||||
<!-- ici la procédure sur comment ajouter une langue -->
|
||||
<!-- Cf. https://discord.com/developers/docs/reference#locales -->
|
||||
1. Créer un nouveau fichier dans [src/locales/](./src/locales/), le fichier
|
||||
doit être nommé `langue.json` avec `langue` suivant
|
||||
[cette liste](https://discord.com/developers/docs/reference#locales).
|
||||
2. Le contenu du fichier peut être copié du fichier de la langue par défaut,
|
||||
[cf. au dessus](#langues).
|
||||
3. Ce sont les valeurs des clés (le texte à gauche des `:`) qui doivent
|
||||
être traduits. Merci par avance !
|
||||
> Ne vous forcez pas à tout traduire. Même une contribution avec
|
||||
> une seule variable de modifiée compte !
|
||||
4. Une fois terminée, [ouvrez une Pull Request](#soumettre-ses-modifications).
|
||||
|
||||
### Mettre à jour une langue
|
||||
<!-- ici la procédure sur comment mettre à jour une langue existante -->
|
||||
1. Rechercher la langue dans le dossier [src/locales/](./src/locales/).
|
||||
2. Modifier/Ajouter des traductions comme
|
||||
[expliquer au dessus](#ajouter-une-langue) (à partir du `3.`).
|
||||
> Pensez à vérifier si de nouvelles valeurs n'ont pas été ajouté dans
|
||||
le fichier langue par défaut, [cf. au dessus](#langues).
|
||||
|
||||
## Soumettre ses modifications
|
||||
Lorsque vous vous sentez confiant dans vos modifications, ouvrez
|
||||
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é.
|
||||
|
||||
Veuillez tester vos modifications avant de les soumettre. **Attention**, ce
|
||||
2. 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
|
||||
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
|
||||
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.
|
||||
|
||||
> **Explication**
|
||||
>
|
||||
> `npm run debug` execute le code depuis le dossier [`src`](src/)
|
||||
> tandis que `npm run main` et l'image Docker le fait depuis le dossier `dist`.
|
||||
>
|
||||
> Docker est cependant différent car dans l'image, le dossier [`src`](src/) est
|
||||
> supprimé.
|
||||
|
||||
### Type de merge
|
||||
<!-- Préciser qu'on utilises "squash" -->
|
||||
## Gestion du dépôt
|
||||
- On ne push jamais directement sur la branche `main`.
|
||||
- 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).
|
||||
|
|
Loading…
Reference in a new issue