From 0168bb3646fe3da6587530bcdff86a15e27b01f6 Mon Sep 17 00:00:00 2001 From: Mylloon Date: Fri, 22 Jul 2022 11:55:55 +0200 Subject: [PATCH 1/6] Add CONTRIBUTING.MD and LICENCE reference --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8eed6c6..c31fd65 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,13 @@ services: | :-----------: | :-----------: | :-: | TOKEN_DISCORD | Token Discord | Aucune ---- -### Références +# Contribuer +Toute contribution est la bienvenue ! + +Pour commencer le développement, lis le [fichier de contribution](./CONTRIBUTING.md). + +# Licence +Voir le [fichier LICENCE](./LICENCE). + +# Références [Photo de profil](https://picrew.me/image_maker/1497656) -- 2.45.2 From 2d4c03f2968cc3dd35743ab2b3f637bc021d75a0 Mon Sep 17 00:00:00 2001 From: Mylloon Date: Fri, 22 Jul 2022 15:21:34 +0200 Subject: [PATCH 2/6] first draft of contributing.md --- CONTRIBUTING.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 CONTRIBUTING.md 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 + -- 2.45.2 From c8f6b9645bfaaaaa37958b0eb84eb26cb19deec3 Mon Sep 17 00:00:00 2001 From: Mylloon Date: Fri, 22 Jul 2022 22:02:49 +0200 Subject: [PATCH 3/6] additions and updates --- CONTRIBUTING.md | 48 +++++++++++++++++++++++++++++++++++++----------- 1 file changed, 37 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cea2dd1..aae4791 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ # 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 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 - - +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 - +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 - +## 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). -- 2.45.2 From 51c3a5407968b94e2b5bad22a529a0ae22a1b496 Mon Sep 17 00:00:00 2001 From: Mylloon Date: Fri, 22 Jul 2022 22:23:43 +0200 Subject: [PATCH 4/6] Add templates --- .gitea/PULL_REQUEST_TEMPLATE.md | 6 ++++++ .gitea/issue_template/BUG.md | 15 +++++++++++++++ .gitea/issue_template/FEATURE.md | 10 ++++++++++ 3 files changed, 31 insertions(+) create mode 100644 .gitea/PULL_REQUEST_TEMPLATE.md create mode 100644 .gitea/issue_template/BUG.md create mode 100644 .gitea/issue_template/FEATURE.md diff --git a/.gitea/PULL_REQUEST_TEMPLATE.md b/.gitea/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..1931905 --- /dev/null +++ b/.gitea/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,6 @@ +Checklist: + +- [ ] Suivre les indications de `CONTRIBUTING.md` +- [ ] Augmente de 1 le numéro de version (soit `x.y.z`, augmentez `z` si +bugfix, `y` si ajout de fonctionnalité et `x` si grande nouveautée) +- [ ] Référence aux tickets (par exemple `Closes #xyz`) diff --git a/.gitea/issue_template/BUG.md b/.gitea/issue_template/BUG.md new file mode 100644 index 0000000..699f95b --- /dev/null +++ b/.gitea/issue_template/BUG.md @@ -0,0 +1,15 @@ +--- + +name: "🐞 Rapport d'un bug" +about: "Signal un problème rencontré" +ref: "main" +labels: + +- bug +- "help wanted" + +--- + +Bot version: v`X.Y.Z` + +Problem : diff --git a/.gitea/issue_template/FEATURE.md b/.gitea/issue_template/FEATURE.md new file mode 100644 index 0000000..be5e348 --- /dev/null +++ b/.gitea/issue_template/FEATURE.md @@ -0,0 +1,10 @@ +--- + +name: "💫 Demande une fonctionnalitée" +about: "Propose une nouvelle fonctionnalité à ajouter" +ref: "main" +labels: + +- enhancement + +--- -- 2.45.2 From 5971bb12415f95c9e6f9842449be014417c9e012 Mon Sep 17 00:00:00 2001 From: Mylloon Date: Fri, 22 Jul 2022 22:29:14 +0200 Subject: [PATCH 5/6] add semantic pr titles --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aae4791..20d5c03 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,9 +51,11 @@ doit être nommé `langue.json` avec `langue` suivant ## 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é. +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. -2. 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 modifié n'est pas référencer ailleurs (exemple : si vous modifier une variable d'environnement, il faut penser à mettre à jour le -- 2.45.2 From ee4a30be32eeace846088b5bda66a64de214e9e4 Mon Sep 17 00:00:00 2001 From: Mylloon Date: Fri, 22 Jul 2022 22:46:34 +0200 Subject: [PATCH 6/6] github style --- .gitea/issue_template/BUG.md | 57 +++++++++++++++++++++++++++++++++--- 1 file changed, 53 insertions(+), 4 deletions(-) diff --git a/.gitea/issue_template/BUG.md b/.gitea/issue_template/BUG.md index 699f95b..cd58f60 100644 --- a/.gitea/issue_template/BUG.md +++ b/.gitea/issue_template/BUG.md @@ -8,8 +8,57 @@ labels: - bug - "help wanted" +body: + + - type: input + id: source + attributes: + label: Version + description: | + Version du bot utilisée + placeholder: | + Exemple : v1.2.3 + validations: + required: true + + - type: textarea + id: reproduce-steps + attributes: + label: Étapes à suivre pour reproduire + description: Donnez un exemple du problème + placeholder: | + Exemple : + 1. Première étape + 2. Deuxième étape + 3. Problème + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Comportement attendu + placeholder: | + Example: + "Normalement..." + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Comportement actuel + placeholder: | + Example: + "Mais actuellement..." + validations: + required: true + + - type: textarea + id: other-details + attributes: + label: Autres détails + placeholder: | + Détails supplémentaires. + --- - -Bot version: v`X.Y.Z` - -Problem : -- 2.45.2