docs: readme explains how to run tests (resolves #3639)#3643
Merged
escapedcat merged 1 commit intoconventional-changelog:masterfrom Aug 16, 2023
Merged
docs: readme explains how to run tests (resolves #3639)#3643escapedcat merged 1 commit intoconventional-changelog:masterfrom
escapedcat merged 1 commit intoconventional-changelog:masterfrom
Conversation
Member
|
Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR Adds documentation for how to run the test suite to a new "testing" section in the README.
Motivation and Context
The pull request template asks contributors to confirm that all tests pass. I could not find documentation for how to run the test suite. Turns out the instructions are pretty clearly implied in the README's "Publishing a release" section. I saw that section's heading and, because I'm not trying to publish, skipped right over it. Can imagine others might too.
Usage examples
During development, relevant for contributors making changes which could affect tests and contributors writing tests.
During proposal: all contributors who open pull requests.
How Has This Been Tested?
I ran the commands listed and confirmed that they ran the test suite.
Types of changes
Checklist: