To allow users to contribute easily and reduce friction, we've opted for a simple, personal-folder based system.
Folders / Naming Etiquette
To use this testing platform, you'll be creating three types of files:
- runners (configuration files)
- tests
- test-helpers (optional but helpful)
Please use your own personal folder (create yourself as needed) within
runners/configuration-files/userstests/user-testshelpers/user-helpers
to store your own files. An easy place to start is to copy a simple example, as explained here.
To learn more about those files, see this doc.
What to Commit?
If you've done something useful, please push it so others can learn from your hard work!
If you've done something unfinished and need/want to push for an unrelated reason, please make sure to clearly mark that work as unfinished somehow, to help keep colleagues from wasting time trying to learn from non-working examples.
Please make sure npm test passes before you push - that means you'll need to appease StandardJS, our linter.
The most common linter issue will be probably declaring all your globals you used (which have come from the platform).
Learning Resources for Beginners
There are a growing number of video tutorials to help you learn to write useful tests quickly.
If you prefer to just read the docs and run something to get a feel for how it works, it's probably best to start here to see the tool in action on your own machine and get comfortable making changes.
There's also a cheatsheet that might help with a first overview.