docs: update CONTRIBUTING.md #35

Merged
Anri merged 12 commits from contributing-update into main 2022-07-25 00:51:02 +02:00
Showing only changes of commit f1f18943a5 - Show all commits

View file

@ -14,6 +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)
- [Ajouter une commande](#ajouter-une-commande)
- [Ajouter un évènement](#ajouter-un-évènement)
- [Soumettre ses modifications](#soumettre-ses-modifications)
- [Gestion du dépôt](#gestion-du-dépôt)
@ -91,6 +92,19 @@ de votre commande.
- facultativement : `"c_COMMANDE_desc": "NOM"` au fichier
de langue, avec `COMMANDE` le nom de la commande et `NOM` le nom 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à.
Vous pouvez préciser que l'évènement ne sera déclenché qu'une seule fois avec
```typescript
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))
## Soumettre ses modifications
1. Lorsque vous vous sentez confiant dans vos modifications, ouvrez
une [Pull Request](https://git.kennel.ml/ConfrerieDuKassoulait/Botanique/pulls)