Skip to content

Commit 464bffe

Browse files
Clarify mcfly instructions (#64446)
1 parent 87f2e8c commit 464bffe

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

‎.github/skills/mcfly/SKILL.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,19 @@ description: Only invoke when explicitly instructed to
44
---
55

66
You need to "re-stack" your commits to match the following format:
7-
* A failing test case
7+
* Testcase(s), including at least one that demonstrate the problem - this could be a test that directly fails, baselines that show the problem, or even both
88
* A commit, or series of commits, that fixes the failing test case
9-
* (Optional) a follow-up commit that checks in any modified baselines
9+
* If needed, a follow-up commit with modified baselines
1010

1111
Since you can't force-push, start with a commit that undoes all your prior changes and gets you back to `main`.
1212

1313
Then add your test case(s) in a single commit.
14+
When you add testcases that create or modify baselines, commit the (pre-fix) baselines at the same time as the testcases themselves.
1415
A test case isn't necessarily a new file; it could be a modification to an existing test or a change in the test configuration.
1516
Ensure that at least one test in the full run fails - you might be operating on a bad PR that didn't actually introduce a failing scenario!
1617
If zero tests failed, abort and post a message explaining what you observed.
1718
Remember that baseline tests do not "fail" in the traditional sense; they are used to verify that the output matches the expected baseline.
18-
You should examine the PR description to determine what the desired passing baseline should look like.
19+
Ensure that your test demonstrates the problem that the PR is intended to fix.
1920

2021
Then, add your fix.
2122
You can break this apart into multiple commits if it's more logical to review that way; use your judgment.

0 commit comments

Comments
 (0)