From 40729cbe22f4a024efacdc828426592d3dbee61f Mon Sep 17 00:00:00 2001 From: Nicholas Ung Date: Wed, 18 Oct 2023 14:13:49 -0700 Subject: [PATCH 1/3] Add command for running tests to PR directions Signed-off-by: Nicholas Ung --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c4b6a1c..a6c8cba 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`. 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. From d6a869e254eb7265c2dec2c61c8097cfe29f0a44 Mon Sep 17 00:00:00 2001 From: Nicholas Ung Date: Thu, 19 Oct 2023 08:56:44 -0700 Subject: [PATCH 2/3] Add more details about -u tag Signed-off-by: Nicholas Ung --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a6c8cba..47a630f 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 by running `yarn test -u`. +3. Ensure local tests pass by running `yarn test -u`. The `-u` flag is an alias for the `--updateSnapshot` option, which automatically updates snapshot files 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. From 3527e240d5aca9ba1dc6a9318b1ab314034365f4 Mon Sep 17 00:00:00 2001 From: Nicholas Ung Date: Thu, 19 Oct 2023 09:13:53 -0700 Subject: [PATCH 3/3] Add reason for snapshot updates Signed-off-by: Nicholas Ung --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 47a630f..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 by running `yarn test -u`. The `-u` flag is an alias for the `--updateSnapshot` option, which automatically updates snapshot files that have been affected by your changes. +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.