Skip to content

Commit ee6e024

Browse files
author
Adel Khamatov
committed
chore: add a path-specific github instructions related to API guidelines
1 parent 941aa14 commit ee6e024

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
applyTo: "**/packages/devextreme/js/common.d.ts"
3+
---
4+
5+
When helping me write code or reviewing my existing code, please follow these specific code style conventions:
6+
7+
1. **Acronym Casing in Identifiers:**
8+
- Treat all acronyms as regular words in camelCase and PascalCase
9+
- Capitalize only the first letter of each acronym, not the entire acronym
10+
- Examples:
11+
-`testDom` (not `testDOM`)
12+
-`parseHtml` (not `parseHTML`)
13+
-`createJsonParser` (not `createJSONParser`)
14+
-`apiEndpoint` (not `APIEndpoint`)
15+
- This applies to all acronyms regardless of length (DOM, HTML, JSON, API, etc.)
16+
17+
2. **JSDoc Format - Omit @type:**
18+
- Do not include the `@type` tag in JSDoc comments when the type is already indicated by TypeScript type annotation
19+
20+
Consistently apply these conventions to all code you review, suggest, complete.

0 commit comments

Comments
 (0)