From cd14b59b9ed3099b465f390b87e402046fdf20cc Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 3 Nov 2023 22:35:02 +0000 Subject: [PATCH] [Doc] Update CONTRIBUTING.md by adding command for running tests to PR directions (#335) * Add command for running tests to PR directions Signed-off-by: Nicholas Ung * Add more details about -u tag Signed-off-by: Nicholas Ung * Add reason for snapshot updates Signed-off-by: Nicholas Ung --------- Signed-off-by: Nicholas Ung (cherry picked from commit 77db9818522a1a4fb0cc914cd770bac61b1916f9) Signed-off-by: github-actions[bot] --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c4b6a1c..7362754 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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`. Snapshot files must always represent the current state of the code they are covering for proper testing to occur. The `-u` flag is an alias for the `--updateSnapshot` option, which automatically updates any snapshots that have been affected by your changes. 4. Commit to your fork using clear commit messages. 5. Send us a pull request, answering any default questions in the pull request interface. 6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.