diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cea2dd1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Comment contribuer ? +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 n'est pas définitif et il est mis à jour au fil du temps. 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 +une [Pull Request](https://git.kennel.ml/ConfrerieDuKassoulait/Botanique/pulls). + +## Sommaire +- [Recevoir de l'aide](#recevoir-de-laide) +- [Langues](#langues) + - [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) + +## Recevoir de l'aide +Si tu as besoin d'aide, tu peux poser ta question sur +le [Discord](https://discord.gg/Z5ePxH4). + +## Langues +La langue par défaut est définie dans [`src/utils/client.ts`](src/utils/client.ts) +dans `client.config.default_lang`. + +La langue par défaut fait office de solution de secours dans le cas où une traduction +est incomplète. On part donc du postulat que la langue par défaut contient toujours +toutes les chaînes de caractère dont le bot a besoin. + + +### Ajouter une langue + + + +### Mettre à jour une langue + + +## Soumettre ses modifications +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 +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. + +> `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 +