From e8e5cc046e3cb3eb33f64f1a9eb756b1b52152d4 Mon Sep 17 00:00:00 2001 From: Ryan Cavanaugh Date: Wed, 18 Jun 2025 11:21:13 -0700 Subject: [PATCH 1/4] Create copilot-instructions.md --- .github/copilot-instructions.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/copilot-instructions.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 0000000000000..e34a892066df3 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,13 @@ + * Read the contents of CONTRIBUTING.md, it has instructions on how to run a single test, handling baselines, etc + * Run `hereby lint` and `hereby format` before you're done + * Only add testcases in `test/cases/compiler` or `tests/cases/fourslash`. Do not write direct unit tests. + * Running a set of tests make take up to 4 minutes + * A full test run make take up to 15 minutes + * Maintainer comments in the issue should generally take priority over OP's comments + * Maintainers might give you hints on where to start. They are not always right, but a good place to start + +Your workflow should be: + * Make a testcase that demonstrates the behavior. Run it (by itself) and review the baselines it generates to ensure it demonstrates the bug. Add the test its baselines in one commit + * Fix the bug by changing code as appropriate. Put this fix in another commit + * Run the test you wrote again and ensure the baselines change in a way that demonstrates that the bug is fixed. Put this baseline diff in its own commit + * Run all other tests to ensure you didn't break anything. Some collateral baseline changes are normal, put these diffs in another commit From 993a1d92126143730c98f6e41406829f0faac638 Mon Sep 17 00:00:00 2001 From: Ryan Cavanaugh Date: Wed, 18 Jun 2025 11:28:19 -0700 Subject: [PATCH 2/4] Update .github/copilot-instructions.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/copilot-instructions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index e34a892066df3..3bcf786e1e72c 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,8 +1,8 @@ * Read the contents of CONTRIBUTING.md, it has instructions on how to run a single test, handling baselines, etc * Run `hereby lint` and `hereby format` before you're done * Only add testcases in `test/cases/compiler` or `tests/cases/fourslash`. Do not write direct unit tests. - * Running a set of tests make take up to 4 minutes - * A full test run make take up to 15 minutes + * Running a set of tests may take up to 4 minutes + * A full test run may take up to 15 minutes * Maintainer comments in the issue should generally take priority over OP's comments * Maintainers might give you hints on where to start. They are not always right, but a good place to start From 4aa6f8f793f6d9faa6814f6915da82597e8b6904 Mon Sep 17 00:00:00 2001 From: Ryan Cavanaugh Date: Wed, 18 Jun 2025 11:29:14 -0700 Subject: [PATCH 3/4] Apply suggestion from @RyanCavanaugh --- .github/copilot-instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 3bcf786e1e72c..cbed64a5f2b02 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -7,7 +7,7 @@ * Maintainers might give you hints on where to start. They are not always right, but a good place to start Your workflow should be: - * Make a testcase that demonstrates the behavior. Run it (by itself) and review the baselines it generates to ensure it demonstrates the bug. Add the test its baselines in one commit + * Make a testcase that demonstrates the behavior. Run it (by itself) and review the baselines it generates to ensure it demonstrates the bug. Add the test and its baselines in one commit * Fix the bug by changing code as appropriate. Put this fix in another commit * Run the test you wrote again and ensure the baselines change in a way that demonstrates that the bug is fixed. Put this baseline diff in its own commit * Run all other tests to ensure you didn't break anything. Some collateral baseline changes are normal, put these diffs in another commit From 97995f4336743e64dcbdf8a04d9fa1ce9fc08de3 Mon Sep 17 00:00:00 2001 From: Ryan Cavanaugh Date: Wed, 18 Jun 2025 11:30:01 -0700 Subject: [PATCH 4/4] Update .github/copilot-instructions.md --- .github/copilot-instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index cbed64a5f2b02..f37f498f1926d 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,6 +1,6 @@ * Read the contents of CONTRIBUTING.md, it has instructions on how to run a single test, handling baselines, etc * Run `hereby lint` and `hereby format` before you're done - * Only add testcases in `test/cases/compiler` or `tests/cases/fourslash`. Do not write direct unit tests. + * Only add testcases in `tests/cases/compiler` or `tests/cases/fourslash`. Do not write direct unit tests. * Running a set of tests may take up to 4 minutes * A full test run may take up to 15 minutes * Maintainer comments in the issue should generally take priority over OP's comments