Add example
Some checks failed
PR Check / lint-and-format (pull_request) Failing after 12s

This commit is contained in:
Mylloon 2024-09-27 12:22:44 +02:00
parent e1607112a7
commit af4585ee2f
Signed by: Anri
GPG key ID: A82D63DFF8D1317F

View file

@ -25,6 +25,7 @@ une [Pull Request](https://git.mylloon.fr/ConfrerieDuKassoulait/Botanique/pulls)
- [Modifier du code](#modifier-du-code)
- [Soumettre ses modifications](#soumettre-ses-modifications)
- [Gestion du dépôt](#gestion-du-dépôt)
- [Tester son code](#tester-son-code)
## Recevoir de l'aide
@ -284,3 +285,18 @@ Pour commencer, vous pouvez jeter un œil aux
[le graphe](https://git.mylloon.fr/ConfrerieDuKassoulait/Botanique/graph).
- De préférences, suivre [ces conventions](https://www.conventionalcommits.org/fr/v1.0.0/)
(cf. cette [partie précédente](#soumettre-ses-modifications)).
## Tester son code
Il est souhaité d'écrire des tests quand cela est possible.
```ts
// eslint-disable-next-line @typescript-eslint/no-require-imports
const { fnReturnsTrue } = require("../src/utils/misc");
describe("test description", () => {
test("test name", () => {
expect(fnReturnsTrue() /* function to test */).toBe(true /* expected result */);
});
});
```