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.

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

Add TESTING document and simplify README #3413

Merged
merged 5 commits into from
Feb 28, 2023
Merged

Add TESTING document and simplify README #3413

merged 5 commits into from
Feb 28, 2023

Conversation

MikeMcC399
Copy link
Contributor

This PR implements the suggestion from #3410.

Detailed testing information is moved from README: Testing into a new docs/TESTING.md file, which has re-worked contents that reflect the introduction of automatic testing. Some text from the original README which is no longer necessary has been removed.

Whilst this PR is open and not yet merged, the documents can be viewed under:

move testing information from README to TESTING
re-write testing information based on current test strategy, test specs. scripts and workflows
@MikeMcC399 MikeMcC399 marked this pull request as ready for review February 27, 2023 07:40
@MikeMcC399 MikeMcC399 requested a review from a team February 27, 2023 07:40
Copy link
Member

@brianebeling brianebeling left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much for this PR. The new additions like npx cypress cache prune are very much appreciated.
Tested every command, works.

What do you think, ready for merge?

@MikeMcC399
Copy link
Contributor Author

@brianebeling

Thanks for checking! Perhaps leave the PR for a day or two before merging to see if there are any other comments or points which are unclear?

The Cypress cache description was previously in the README. I moved it to TESTING and shortened it.

@brianebeling
Copy link
Member

Brian-J. Ebeling

Thanks for checking! Perhaps leave the PR for a day or two before merging to see if there are any other comments or points which are unclear?

The Cypress cache description was previously in the README. I moved it to TESTING and shortened it.

Sure. Additions may have been the wrong term - rewordings. I think it reads as good as new.

README.md Outdated Show resolved Hide resolved
Co-authored-by: Lars <wittmershaus.lars@gmail.com>
Copy link
Contributor

@Ein-Tim Ein-Tim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very good in general, thank you!

docs/TESTING.md Show resolved Hide resolved
docs/TESTING.md Show resolved Hide resolved
Copy link
Contributor

@Ein-Tim Ein-Tim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@brianebeling brianebeling merged commit 62d38da into corona-warn-app:master Feb 28, 2023
@MikeMcC399 MikeMcC399 deleted the docs/testing-update branch February 28, 2023 09:30
@larswmh larswmh mentioned this pull request Mar 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants