corona-warn-app / cwa-website

Corona-Warn-App website. The CWA development ended on May 31, 2023. You still can warn other users until April 30, 2023. More information:
https://coronawarn.app/en/faq/#ramp_down
Apache License 2.0
522 stars 225 forks source link

Simplify testing description in README #3410

Closed MikeMcC399 closed 1 year ago

MikeMcC399 commented 1 year ago

This is a suggestion to simplify the information in the README document regarding testing. Over time this section has grown and now that several workflows have been implemented, it is not necessary to keep all the information at the top level of the documentation hierarchy.

Current situation

The README: Testing section contains detailed information on testing with Cypress.

In the meantime most of the tests are integrated into workflows and do not need to be run manually.

Suggestion

Move detailed testing information from README: Testing into a new docs/TESTING.md file.


Internal Tracking ID: EXPOSUREAPP-14856

MikeMcC399 commented 1 year ago

I will take a look at this and either add some more information to this proposal or just submit a PR.

brianebeling commented 1 year ago

Thanks Mike, some housekeeping is definitely due. The question is where to put the information.

A) in the docs folder B) in the root folder

Considering that the docs folder contains file actively needed to work on this project I would like to propose to put it there as well with a default one liner for testing and link to the full documentation from the readme.

MikeMcC399 commented 1 year ago

@brianebeling

I plan to add a document TESTING.md to the docs folder. I just need to proof-read what I have already written and I will post a new PR soon.

MikeMcC399 commented 1 year ago