Add typedoc

[rbdr/forum] / README.md

diff --git a/README.md b/README.md
index ac80064099a1b70881cb74ca45578358cf4a88c4..3e0f099872da2f0944ac77c52756fb317dfd1bea 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,5 +14,17 @@ root of the project.
 This project depends on the [forum server][forum-server], so make sure
 that's running before starting.
 
 This project depends on the [forum server][forum-server], so make sure
 that's running before starting.
 

+## Testing
+
+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
 [node]: https://nodejs.org/en/
 [forum-server]: https://gitlab.com/rbdr/forum-server