From fddaf86789eb077b68e0ff2a25ab1a165e316562 Mon Sep 17 00:00:00 2001 From: Mylloon Date: Mon, 25 Jul 2022 00:49:34 +0200 Subject: [PATCH] add project info --- CONTRIBUTING.md | 38 +++++++++++++++++++++++++++++--------- 1 file changed, 29 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cae566d..850d791 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,7 @@ une [Pull Request](https://git.kennel.ml/ConfrerieDuKassoulait/Botanique/pulls). - [Langues](#langues) - [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) - [Modifier du code](#modifier-du-code) @@ -24,12 +25,12 @@ 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 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. +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 @@ -51,6 +52,23 @@ doit être nommé `langue.json` avec `langue` suivant > Pensez à vérifier si de nouvelles valeurs n'ont pas été ajouté dans le fichier langue par défaut, [cf. au dessus](#langues). +## Projet +Le code se trouve dans le dosier [src/](./src/). Dans ce dossier il y a : +- [commands/](./src/commands/) qui contient toutes les commandes, rangés par +catégories +- [events/](./src/events/) qui contient tous les évènements, rangés par +catégories +- [locales/](./src/locales/) qui contient tous les fichiers de langue +- [modules/](./src/modules/) qui contient les extensions utilisé, + par exemple, pour utiliser la fonction `capitalize()` d'un string, il faut + importer le fichier `string.ts` qui se trouve dans le dossier +- [utils/](./src/utils/) qui contient toutes les fonctions utilitaires, rangés +par fichiers + +Les dossiers [commands/](./src/commands/) et [events/](./src/events/) +contiennent chaquin un fichier `loader.js` qui charge respectivement +les commandes et les évènements dans le bot. + ## Ajouter une commande Pour ajouter une commande au bot, créez un fichier `nom-de-la-commande.ts` dans un sous dossier de [`src/commands/`](./src/commands/). Vous pouvez créer une @@ -98,9 +116,10 @@ la commande et `NOM` le nom de votre commande. le nom de la commande et `DESCRIPTION` la description de votre commande. ## Ajouter un évènement -Pour ajouter le support d'un évènement au bot, créez un fichier `nom-evenement.ts` dans -un sous dossier de [`src/events/`](./src/events/). Vous pouvez créer une -nouvelle catégorie si votre commande n'entre dans aucune qui existe déjà. +Pour ajouter le support d'un évènement au bot, créez un fichier +`nom-evenement.ts` dans un sous dossier de [`src/events/`](./src/events/). Vous +pouvez créer une nouvelle catégorie si votre commande n'entre dans aucune qui +existe déjà. Vous pouvez préciser que l'évènement ne sera déclenché qu'une seule fois avec ```typescript @@ -108,7 +127,8 @@ export const once = true; ``` De préférence, merci de mettre un lien en commentaire vers la documentation -de discord.js de l'évènement ([exemple ici pour l'évènement `ready`](./src/events/client/ready.ts#L3)) +de discord.js de l'évènement +([exemple ici pour l'évènement `ready`](./src/events/client/ready.ts#L3)) ## Modifier du code Quand vous modifiez quelque chose, pensez à mettre-à-jour les langues. Si vous