From: Ruben Beltran del Rio Date: Mon, 3 May 2021 19:18:29 +0000 (+0200) Subject: Update documentation X-Git-Url: https://git.r.bdr.sh/rbdr/forum/commitdiff_plain/fb76052a02708a8fafa310d99d7d7b403b4b7ad8?ds=inline Update documentation --- diff --git a/.eslintignore b/.eslintignore index 4234ddf..4aadab1 100644 --- a/.eslintignore +++ b/.eslintignore @@ -1,3 +1,4 @@ assets +build dist .gitignore diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bf67cc2..4da23c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,6 +24,7 @@ Some ideas so far include: Above All: Be nice, always. - Ensure the style checkers show no warnings or errors +- Make sure all tetsts are passing - Don't break the CI - Make the PRs according to [Git Flow][gitflow]: (features go to develop, hotfixes go to master) diff --git a/README.md b/README.md index e78b591..e8b6201 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,14 @@ that's running before starting. ## Testing -You can run tests with `npm test`. The tests use `testing-library` and -`jest`. +You can run tests with `npm test`. The tests use `testing-library`, `pact`, +and `jest`. Here's some short guidelines: - Every component that receives props or changes state should be tested. - Test expected outcomes, not implementation details. - Avoid mocking unless it's an external call + - Stores that interact with the API should be tested using pact [node]: https://nodejs.org/en/ [forum-server]: https://gitlab.com/rbdr/forum-server