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.

Sign up for GitHub

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

Jump to bottom

Restructure README.md #17

Open
edalex-ian opened this issue Jan 23, 2019 · 0 comments
Open

Restructure README.md #17

edalex-ian opened this issue Jan 23, 2019 · 0 comments

Comments

@edalex-ian
Copy link
Member

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:

  1. Overview - incl. OldTests vs Tests, tech/frameworks used
  2. Dependencies - sbt, yarn, chromedriver, oEQ instance (maybe link below)
  3. Quick Start - Minimum steps from cloning to running full suite (link to other sections as needed)
  4. Target Server Setup and Requirements - covering three options/modes
  5. Test Configuration - application.conf, TestNG files, CLI options for ScalaCheck
  6. Test Reports / Screenshots
  7. Coverage Report
  8. Troubleshooting - including how to re-run tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@edalex-ian