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

docs: readme explains how to run tests (resolves #3639) #3643

Merged

Conversation

olets
Copy link
Contributor

@olets olets commented Aug 15, 2023

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@escapedcat
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants