Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation to how our testing framework is setup and how to write tests #875

Open
5 tasks
ckbedwell opened this issue Jul 22, 2024 · 0 comments
Open
5 tasks
Labels
documentation Improvements or additions to documentation

Comments

@ckbedwell
Copy link
Contributor

Problem

We have quite a comprehensive testing framework that does a lot of the heavy lifting for making writing tests as pain free as possible however none of this is documented.

Completion criteria

Please create documentation in the repo that outlines:

  • How our testing framework is set up and initialised
  • What assumptions it makes and does for you out of the box (e.g. the custom render method, MSW happy paths)
  • What helper functions are available (e.g. runTestAsViewer), options you can provide the custom render method (e.g. routing options, custom meta, etc.)
  • How to write tests
  • Outlines how larger features have a meta testing framework with their own helpers to reduce writing boilerplate. See PR: Check form redesign #847
@ckbedwell ckbedwell added the documentation Improvements or additions to documentation label Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant