StateVoicesNational
wip: test writing documentation
Fixes no full documentation on how to write tests
Description
Let's document testing patterns, gotchas and best practices.
- [ ] Figure out when we really need mount() vs. shallow() in React components
- [ ] put a
sleepin ./lib or somewhere else appropriate (and document)
and generally need more details. This outline is meant to be fleshed out -- please help expand!
- [x] My PR is labeled [WIP] if it is in progress
This is so helpful!! I can try and help add stuff on too. Do you think we could merge it as is but included that we need more contributions to it? Just to make folks are actually able to find what's already here?
Does this cover this issue? #410
No -- worker processes are background 'cron' jobs -- this is for how to run tests, which we would need to update, if we merged this -- e.g. we should at least link to Cypress test documentation I believe we have.
@schuyler1d is this the documentation you're referring to? https://github.com/MoveOnOrg/Spoke/blob/ddd32f474461da98d6377b59e8a2f76099370543/docs/HOWTO-run_tests.md#integration-testing
hey @schuyler1d wondering if you might want to add this as a change to this existing document? https://github.com/MoveOnOrg/Spoke/blob/main/docs/HOWTO-run_tests.md
I think we were thinking of it as a separate document just to separate the 'I made a change and want to run the tests' vs. 'I am writing a test' which is more a subset of code guidelines. But agree that either way it would work -- it's more the task of completing this document (and then putting it somewhere)
hm! in that case @schuyler1d do you think it would be beneficial to merge as-is, perhaps with a caveat text at the bottom that this document could use more work, so that there is more visibility on this doc and folks might be inspired to add to it?
@schuyler1d I think it would be great to merge as-is and get folks adding to this/contributing more! what do you think?