docs: restructure run tests documentation #862
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goals
In the README the goals are:
Change
This PR restructures the README section about running tests.
It starts from a set of instructions to clone and run, which can be simply copied and pasted. It explains then in more detail about options and what happens behind the scenes.
Local testing and CI testing are clearly separated.
Documentation and getting help are also separated from the instructions about running tests.
The link to the 5 year old CHANGELOG_OLD.md in the
README
is also removed as this is now very old and no longer needed / helpful. The file itself is left in place