|
| 1 | +# GitHub Copilot Instructions |
| 2 | + |
| 3 | +These instructions summarize the DevExpress/devextreme-documentation repository so you can make efficient, correct suggestions with minimal exploratory searching. Trust these instructions first; search only if certain information is missing or proves inaccurate. |
| 4 | + |
| 5 | +This repository contains source Markdown files, embedded sample applications, images, and reusable include fragments for the public DevExtreme documentation site: https://js.devexpress.com/Documentation/. |
| 6 | + |
| 7 | +This repository is a content + light tooling project (not a compiled application). Your typical changes will involve: |
| 8 | +- Reviewing style consistency and grammar of documentation content. The documentation content is straightforward technical writing targeting a software developer audience. |
| 9 | +- Reviewing link/reference consistency and accuracy in documentation content. |
| 10 | +- Reviewing style consistency of code samples (JavaScript/HTML/CSS/TypeScript). |
| 11 | +- Reviewing technical accuracy of code samples (JavaScript/HTML/CSS/TypeScript). |
| 12 | + |
| 13 | +What you need to do: |
| 14 | +- You will review Pull Requests (PRs) submitted by contributors. |
| 15 | +- You will leave comments on PRs when you spot issues. |
| 16 | +What you will not do: |
| 17 | +- YOU WILL NOT SUBMIT PRS YOURSELF. |
| 18 | +- YOU WILL NOT WRITE NEW DOCUMENTATION CONTENT YOURSELF. |
| 19 | + |
| 20 | +When reviewing PRs, please follow these guidelines: |
| 21 | + |
| 22 | +When reviewing documentation content: |
| 23 | +1. Follow American English spelling and grammar. |
| 24 | +2. Use active voice and present tense. Prefer active sentences with clear subject, object, and verb. |
| 25 | +3. Use consistent terminology (refer to existing documentation). |
| 26 | +4. Do not use contractions and elisions; prefer full/complete wording versions. |
| 27 | +5. All the headings should use Title Case. Do not use end punctuation (periods) at the end of headings. |
| 28 | +6. Remember to write alt text for images. |
| 29 | +7. Use the Oxford comma. |
| 30 | +8. Avoid introductory dependent clauses followed by commas (e.g., prefer "The function returns true" over "When called, the function returns true"). |
| 31 | + |
| 32 | +When reviewing code samples: |
| 33 | +1. Follow the existing code style in the file. |
| 34 | +2. Ensure code samples follow best practices for the relevant technology. For example, Vue samples should use the Composition API + TS. React samples should use functional components + hooks + TS. |
0 commit comments