Skip to content

Commit 0064d14

Browse files
Attempt to make copilot smarter (#3708)
Signed-off-by: Diana <[email protected]> Co-authored-by: tomek-labuk <[email protected]>
1 parent 6f29c40 commit 0064d14

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

.github/copilot-instructions.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
This is a docs repository for the Kong Developer site (https://developer.konghq.com/). We use Jekyll, Netlify, Ruby, and then write our docs in Markdown and YAML. Please use these guidelines when you are asked to create a PR, write a commit, or review a PR:
2+
3+
## Required Before Each Commit
4+
- Run `make run` before committing any changes to ensure there aren't any issues with the site building
5+
6+
## Repository Structure
7+
- The /tools directory contains all the information about how our different tooling works, such as automated tests, autogenerating new plugin scaffolding, and changelog generator
8+
9+
## PR reviews
10+
11+
When you leave PR reviews, always provide GitHub suggestions with actionable feedback that the PR creator can directly commit. For example, don't say "Change this variable.", instead, create a comment with a suggestion that changes the variable to the correct one.
12+
13+
## Key Guidelines
14+
- We write three types of docs: reference, landing page (written in yaml), and how-tos
15+
- When you write or edit a doc, use app/contributing/index.md to format the body text (as well as code blocks) correctly for each page type
16+
- When writing or editing UI steps, use the formats listed in docs/ui-steps-standards.md
17+
- When adding tags to the frontmatter, follow the instructions here: docs/update-tag-schema.md
18+
- For anything that is added to the frontmatter of a doc, use docs/front-matter-reference.md for a reference

0 commit comments

Comments
 (0)