You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/instructions/code.instructions.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,10 +9,10 @@ For code reviews, follow guidelines, tests, and validate instructions. For creat
9
9
## Guidelines
10
10
11
11
- If available, use ripgrep (`rg`) instead of `grep`.
12
-
-Make sure to always _escape backticks_ when using gh cli.
12
+
-When using gh cli, always _escape backticks_.
13
13
- All scripts should be listed in `package.json` and use `tsx`.
14
-
- Whenever you create or comment on an issue or pull request, indicate you are an LLM.
15
-
- Be careful fetching full HTML pages off the internet. Prefer to use gh cli whenever possible for github.com. Limit the number of tokens when grabbing HTML.
14
+
- Whenever you create or comment on an issue or pull request, indicate you are GitHub Copilot.
15
+
- Be careful fetching full HTML pages off the internet. Prefer to use MCP or gh cli whenever possible for github.com. Limit the number of tokens when grabbing HTML.
16
16
- Avoid pull requests with over 300 lines of code changed. When significantly larger, offer to split up into smaller pull requests if possible.
17
17
- All new code should be written in TypeScript and not JavaScript.
18
18
- We use absolute imports, relative to the `src` directory, using the `@` symbol. For example, `getRedirect` which lives in `src/redirects/lib/get-redirect.ts` can be imported with `import getRedirect from '@/redirects/lib/get-redirect'`. The same rule applies for TypeScript (`.ts`) imports, e.g. `import type { GeneralSearchHit } from '@/search/types'`
@@ -43,7 +43,7 @@ Run the following commands to validate your changes:
43
43
44
44
0. Ask the human if they would like you to follow these steps.
45
45
1. If this is new work, make sure you have the latest changes by running `git checkout main && git pull`. If this is existing work, update the branch you are working on with the head branch -- usually `main`.
46
-
2. If the human provides a GitHub issue, use gh cli to read the issue and all comments.
46
+
2. If the human provides a GitHub issue, use MCP or gh cli to read the issue and all comments.
47
47
3. Begin by evaluating impact, effort, and estimate non-test lines of code that will change. Ask for more context and examples if needed.
48
48
4. If you are running in agentic mode, _stop_ at this point and request approval from the human.
49
49
5. If you need to add or change tests, work on tests before implementing.
@@ -52,7 +52,7 @@ Run the following commands to validate your changes:
52
52
8. Validate that any new or changed tests pass. See "Tests".
53
53
9. Validate that these changes meet our guidelines. See "Guidelines".
54
54
10. If you are running in agentic mode, _stop_ at this point and request review before continuing. Suggest how the human should review the changes.
55
-
11. If a branch and pull request already exist, commit and push, then _concisely_ comment on the pull request that you are an LLM and what changes you made and why.
55
+
11. If a branch and pull request already exist, commit and push, then _concisely_ comment on the pull request that you are GitHub Copilot and what changes you made and why.
56
56
12. If this is new work and no pull request exists yet, make a pull request:
57
57
- label "llm-generated"
58
58
- draft mode
@@ -61,4 +61,4 @@ Run the following commands to validate your changes:
61
61
14. If you are in agentic mode, offer to do any or all of:
62
62
- mark the pull request as ready,
63
63
- assign the issue to the human if it is not already assigned,
64
-
-_concisely_ comment on the issue explaining the change, indicating you are an LLM.
64
+
-_concisely_ comment on the issue explaining the change, indicating you are GitHub Copilot.
0 commit comments