Skip to content

Commit 4a8df2a

Browse files
Update documentation for session completion and debugging...
...including mandatory tasks, debugging tips, and common commands.
1 parent 9085e8e commit 4a8df2a

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

.github/copilot-library.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,33 @@
1+
# How to Give Up
2+
3+
> Running out of time? Here's what to do
4+
5+
If you're being told to wrap up because you're out of time, we'd like you to still submit the testcase you wrote even if it's failing.
6+
Also discuss what determinations you've made so far, e.g. what your experiments demonstrated and what you think the next steps are.
7+
Write these in a format that we can put in the issue to help you on a future iteration.
8+
For example, write down why initial theories you had turned out to be incorrect, or other useful notes.
9+
10+
# Common Commands
11+
12+
> Command listing for how to build, run, format, lint, etc
13+
14+
```
15+
npx hereby local # Build the compiler into built/local
16+
npx hereby runtests-parallel # Run all tests; this may take 15 minutes or longer
17+
npx hereby runtests -t <grep> # Run testcases matching a specific pattern
18+
npx hereby baseline-accept # Accept new test baselines
19+
npx hereby lint # Run lint. Always do this before submitting
20+
npx hereby format # Run code formatting. Always do this before submitting
21+
```
22+
123
# How to Finish a Session
224

325
> Information about mandatory tasks to do at the end of a session
426
527
When you think you're done, there are some mandatory things you need to do before finishing your task and completing your fix.
628

29+
If you have a fix, explain in 1-4 paragraphs your understanding of the origin of the bug and why your fix is the correct one.
30+
731
If you haven't already, run `hereby runtests-parallel` and ensure there are zero errors. Read the sections on Baseline Tests if you don't know how to manage the output of baseline diffs.
832

933
Next, run `hereby lint`. Fix any errors reported here. Lint errors will generally never cause new test failures to appear.

0 commit comments

Comments
 (0)