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

fix: Remove run all tests section #12313

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

chrisleewilcox
Copy link
Contributor

@chrisleewilcox chrisleewilcox commented Nov 15, 2024

Description

Run all test locally with a single command is not recommended as running all tests are not ran in the same manner on CI. This will also prevent some confusion with new contributors running all test the first time which will take a long time. Removing the run all test section will make it more clear to new contributors to run a specific test or a suite of tests as currently documented and is more align with how we run test in CI.

Related issues

Fixes:

Manual testing steps

  1. document running a single test
  2. document running a suite of tests
  3. no document for running all test with a single command

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

Run all test locally is not recommended as test are not ran in the same manner on CI.  This will also prevent some confusion with contributors running the test the first time and having all test run which will take a long time.  Removing the run all test section will make it more clear to new contributors to run a specific test or a suite of tests as currently documented.
Copy link
Contributor

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

Copy link

sonarcloud bot commented Nov 15, 2024

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

Successfully merging this pull request may close these issues.

2 participants