Skip to content

Commit cb66ce9

Browse files
committed
Add custom prompt
Signed-off-by: Dan Barr <[email protected]>
1 parent cdbcde1 commit cb66ce9

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
mode: agent
3+
tools: ['codebase', 'problems', 'changes', 'editFiles', 'runCommands']
4+
description: 'Perform a documentation clarity and style review'
5+
---
6+
7+
Perform a review of the documentation provided in the context.
8+
9+
If explicit content is not provided, perform a review of all changes between the
10+
current branch and the `main` branch, including committed and unstaged changes.
11+
Use a PR-style approach: review all changed files, including documentation and
12+
code, and provide actionable feedback.
13+
14+
**Review instructions:**
15+
16+
- Focus on clarity, conciseness, technical accuracy, and adherence to the
17+
writing style guide.
18+
- For documentation, check tone, accessibility, and user-friendliness for
19+
developers and DevOps professionals.
20+
- For code, check correctness, readability, maintainability, and adherence to
21+
project conventions.
22+
- Use inline comments or suggestions for specific lines or sections.
23+
- Summarize major issues and list minor suggestions.
24+
- Indicate whether you would "approve", "request changes", or "comment" as in a
25+
typical PR review.
26+
27+
Refer to the writing style guide:
28+
[copilot-instructions.md](../copilot-instructions.md)
29+
30+
You can run `editFiles` to make changes based on your review. You can also run
31+
`runCommands` to test the site or check for errors:
32+
33+
- `npm run build` to build the documentation site.
34+
- `npm run start` to start the local development server.
35+
- `npm run prettier` to check formatting.
36+
- `npm run markdownlint` to check for linting errors.
37+
- `npm run eslint` to check for JavaScript/TypeScript linting errors.

.markdownlint-cli2.jsonc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@
55
"docs/toolhive/reference/cli/",
66
"static/api-specs/*.md",
77
".github/pull_request_template.md",
8+
".github/prompts/*.md",
89
],
910
}

0 commit comments

Comments
 (0)