[Doc] Update CONTRIBUTING.md by adding command for running tests to PR directions #335
Conversation
This file contains 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
Signed-off-by: Nicholas Ung <nicholasung22@gmail.com>
nung22
requested review from
macohen,
mingshl,
msfroh,
noCharger and
sejli
as code owners
Codecov Report
@@ Coverage Diff @@
## main #335 +/- ##
=======================================
Coverage 87.08% 87.08%
=======================================
Files 16 16
Lines 209 209
Branches 43 43
=======================================
Hits 182 182
Misses 26 26
Partials 1 1
Flags with carried forward coverage won't be shown. Click here to find out more. |
nung22
changed the title
sejli
reviewed
Oct 18, 2023
CONTRIBUTING.md
Outdated
| @@ -31,7 +31,7 @@ To send us a pull request, please: | |||
|
|
|||
| 1. Fork the repository. | |||
| 2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. | |||
| 3. Ensure local tests pass. | |||
| 3. Ensure local tests pass by running `yarn test -u`. | |||
There was a problem hiding this comment.
We could be a little bit more descriptive here. Could you add a bit that mentions why we need to add the -u tag? I.e., what it does and why do the snapshots need updating
There was a problem hiding this comment.
Thanks for the input @sejli! Just added more details per your suggestions.
Signed-off-by: Nicholas Ung <nicholasung22@gmail.com>
Signed-off-by: Nicholas Ung <nicholasung22@gmail.com>
macohen
approved these changes
Oct 19, 2023
github-actions bot
added a commit
that referenced
this pull request
Nov 3, 2023
…R directions (#335) * Add command for running tests to PR directions Signed-off-by: Nicholas Ung <nicholasung22@gmail.com> * Add more details about -u tag Signed-off-by: Nicholas Ung <nicholasung22@gmail.com> * Add reason for snapshot updates Signed-off-by: Nicholas Ung <nicholasung22@gmail.com> --------- Signed-off-by: Nicholas Ung <nicholasung22@gmail.com> (cherry picked from commit 77db981) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
sejli
pushed a commit
that referenced
this pull request
Nov 3, 2023
…R directions (#335) (#347) * Add command for running tests to PR directions * Add more details about -u tag * Add reason for snapshot updates --------- (cherry picked from commit 77db981) Signed-off-by: Nicholas Ung <nicholasung22@gmail.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
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
Updates the
CONTRIBUTING.mdfile with more details by including the command to run local tests.Issues Resolved
N/A
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.