Skip to content

Commit 47b5b29

Browse files
Add information about repository and common commands...
...to the copilot instructions for better guidance.
1 parent e9092c6 commit 47b5b29

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

.github/copilot-instructions.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ MOST OPERATIONS (adding tests, running them, etc) HAVE RELEVANT DOCUMENTATION.
1010

1111
YOU MUST FOLLOW DIRECTIONS FROM THE "HOW TO FINISH A SESSION" TOPIC BEFORE FINISHING A PULL REQUEST.
1212

13+
## Information About This Repo
14+
15+
Facts you should know and remember:
16+
* All tests can run and pass in this environment. There are no "unrelated" test failures!
17+
* Test "failures" due to baseline changes are normal as a result of your changes, but they MUST BE ADDRESSED. Read the "Dealing with Baselines" topic to learn more.
18+
* Maintainer comments in the issue should generally take priority over OP's comments
19+
* Maintainers might give you hints on where to start. They are not always right, but a good place to start
20+
1321
## Mandatory Workflow
1422

1523
When you clone this repo, ALL THE TESTS ARE PASSING. There are no "unrelated" test failures here; if a test is failing, it's because of your change, and you need to address that one way or another.
@@ -48,8 +56,6 @@ In particular, pay attention to which phase the bug occurs in. For example:
4856
* If the bug is in the checker, you should be able to explain why the logic is wrong with constrasting examples
4957
* If the bug is in the emitter, you should be able to demonstrate that the syntax tree is correct, but that the emit logic is wrong and why
5058

51-
Always read maintainer comments that ask you for demonstrated reasoning about particular aspects of the bug.
52-
5359
## Time Constraints
5460

5561
If you're running out of time, consult the "How to give up" documentation topic.
@@ -60,8 +66,6 @@ We want to make you smarter over time.
6066
If you encounter a situation where you think a developer on this project would be able to provide a useful answer *and* it's not something offered by the Documentation MCP server, add a question to the file `.github/copilot-questions.md`
6167
Explain what you searched for so that we can put the right search terms in the documentation library.
6268

63-
IT'S A BAD FORM IF YOU DON'T ASK AT LEAST ONE QUESTION, IT SHOWS YOU ARE NOT LEVERAGING THE INSTRUCTIONS.
64-
6569
## Common Commands
6670

6771
You'll need to run these commands often. Always use `npx` to run `hereby` commands.
@@ -74,8 +78,3 @@ npx hereby baseline-accept # Accept new test baselines
7478
npx hereby lint # Run lint. Always do this before submitting
7579
npx hereby format # Run code formatting. Always do this before submitting
7680
```
77-
78-
## Understanding the Assigned Task
79-
80-
- Maintainer comments in the issue should generally take priority over OP's comments
81-
- Maintainers might give you hints on where to start. They are not always right, but a good place to start

0 commit comments

Comments
 (0)