chore: update doc (#95)
All checks were successful
ci/woodpecker/push/publish Pipeline was successful

Co-authored-by: Mylloon <kennel.anri@tutanota.com>
Reviewed-on: #95
This commit is contained in:
Mylloon 2023-04-27 22:27:29 +02:00
parent ed03a14323
commit 58be4a54c5
Signed by: Forgejo
GPG key ID: E72245C752A07631

View file

@ -209,6 +209,30 @@ même message.
Contrairement aux autres éléments, les boutons doivent se faire collecter via Contrairement aux autres éléments, les boutons doivent se faire collecter via
la fonction [`collect`](./src/buttons/loader.ts#L46) juste après leur déclaration. la fonction [`collect`](./src/buttons/loader.ts#L46) juste après leur déclaration.
## Autocomplétion
La réponse qu'attent Discord doit se faire obligatoirement sous 3 secondes.
Pour se faire on peut utiliser un timeout avec
[une race](https://fr.wikipedia.org/wiki/Situation_de_comp%C3%A9tition).
```typescript
let timeoutId: NodeJS.Timeout;
const delay = new Promise(function (_, reject) {
timeoutId = setTimeout(function () {
reject(new Error());
}, 2900); // correspond au temps du timeout en ms
});
const resultat = await Promise.race([delay, commandeQuiRenvoieUnPromise])
.then((res) => {
clearTimeout(timeoutId);
return resultatVoulu;
})
.catch(() => {
return resultatErreur; // correspond à temps écoulé ou erreur de notre commande
});
```
## Modifier du code ## Modifier du code
Quand vous modifiez quelque chose, pensez à mettre-à-jour les langues. Si vous Quand vous modifiez quelque chose, pensez à mettre-à-jour les langues. Si vous
@ -242,7 +266,7 @@ Pour commencer, vous pouvez jeté un oeil aux
4. Lorsque vous vous sentez confiant dans vos modifications, ouvrez 4. Lorsque vous vous sentez confiant dans vos modifications, ouvrez
une [Pull Request](https://git.mylloon.fr/ConfrerieDuKassoulait/Botanique/pulls) une [Pull Request](https://git.mylloon.fr/ConfrerieDuKassoulait/Botanique/pulls)
afin que votre code puisse être revu et fusionné. Vous pouvez suivre cette afin que votre code puisse être revu et fusionné. Vous pouvez suivre cette
[condition de nommage](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716#example), [condition de nommage](https://www.conventionalcommits.org/fr/v1.0.0/),
ça aide à s'y retrouver plus rapidement. ça aide à s'y retrouver plus rapidement.
> **Explication** > **Explication**
@ -259,6 +283,5 @@ Pour commencer, vous pouvez jeté un oeil aux
- Quand on merge des modifications vers `main`, on fait un _squash_, - Quand on merge des modifications vers `main`, on fait un _squash_,
l'historique des modifications reste disponible dans l'historique des modifications reste disponible dans
[le graph](https://git.mylloon.fr/ConfrerieDuKassoulait/Botanique/graph). [le graph](https://git.mylloon.fr/ConfrerieDuKassoulait/Botanique/graph).
- De préférences, suivre les indications de - De préférences, suivre [ces conventions](https://www.conventionalcommits.org/fr/v1.0.0/)
[ce post](https://gist.github.com/revett/88ee5abf5a9a097b4c88) (c'est un peu la (cf. cette [partie précédente](#soumettre-ses-modifications)).
même que dans le `4.` de [la partie précédente](#soumettre-ses-modifications)).