The README.md currently is presenting almost as a stream of thoughts as more detail has been gradually added over time.
I suggest we revisit it's structure, as well as including a nice concise overview of running the tests.
Maybe a structure like:
- Overview - incl. OldTests vs Tests, tech/frameworks used
- Dependencies - sbt, yarn, chromedriver, oEQ instance (maybe link below)
- Quick Start - Minimum steps from cloning to running full suite (link to other sections as needed)
- Target Server Setup and Requirements - covering three options/modes
- Test Configuration - application.conf, TestNG files, CLI options for ScalaCheck
- Test Reports / Screenshots
- Coverage Report
- Troubleshooting - including how to re-run tests
The README.md currently is presenting almost as a stream of thoughts as more detail has been gradually added over time.
I suggest we revisit it's structure, as well as including a nice concise overview of running the tests.
Maybe a structure like: