|
1 | | -Welcome, Copilot! This file provides context and coding guidelines for assisting in this React Native project. Instructions are |
2 | | -split into two sections. General instructions and project specific instructions. General instructions are shared across all projects, |
3 | | -between members of RN team. They include general good code practices and approached applicable across projects. These should be |
4 | | -updated by changes to RN project template. |
| 1 | +Welcome, Copilot! This file provides context and coding guidelines for assisting with this React Native project. Instructions are divided |
| 2 | +into two sections: General Instructions and Project-Specific Instructions. General Instructions are shared across all projects within the |
| 3 | +RN team and include best practices applicable across projects. These should be updated as changes are made to the RN project template. |
5 | 4 |
|
6 | | -Project specific instructions have bigger priority and can override general instructions. These are set up per project |
7 | | -and are updated in a process of project development. |
| 5 | +Project-Specific Instructions take precedence and can override General Instructions. These are tailored to the specific needs of the project |
| 6 | +and are updated throughout the development process. |
8 | 7 |
|
9 | | -# ------------------------------------------------------------------------------------------------- |
10 | | - |
11 | | -# GENERAL INSTRUCTIONS |
12 | | - |
13 | | -# ------------------------------------------------------------------------------------------------- |
| 8 | +# ------------------------ GENERAL INSTRUCTIONS ------------------------ |
14 | 9 |
|
15 | 10 | ### About |
16 | 11 |
|
17 | 12 | - This is a React Native app built with Expo and TypeScript. |
18 | | -- Project uses pnpm as a package manager. |
| 13 | +- The project uses pnpm as its package manager. |
19 | 14 |
|
20 | | -### Code quality tools |
| 15 | +### Code Quality Tools |
21 | 16 |
|
22 | | -- Project uses ESLint + Prettier (auto-formatting & rules) |
| 17 | +- The project uses ESLint and Prettier for auto-formatting and enforcing coding rules. |
23 | 18 |
|
24 | | -### Code style |
| 19 | +### Code Style |
25 | 20 |
|
26 | 21 | - Prefer destructuring for props and objects. |
27 | 22 | - Use modern TypeScript syntax and features. |
28 | 23 | - Use arrow functions for components. |
29 | 24 | - Avoid deprecated or legacy APIs. |
30 | 25 | - Use `async/await` for asynchronous operations. |
31 | 26 |
|
32 | | -### Preferred modules and libraries |
| 27 | +### Preferred Modules and Libraries |
33 | 28 |
|
34 | 29 | - Use `expo-router` for navigation. |
35 | 30 | - Prefer the usage of Expo libraries when available. |
36 | 31 |
|
37 | | -### Chat and communication |
| 32 | +### Chat and Communication |
38 | 33 |
|
39 | | -- When suggesting code changes in chat, make sure to include imports at the top of the file. |
| 34 | +- When suggesting code changes in chat, ensure imports are included at the top of the file. |
40 | 35 |
|
41 | 36 | ### Animations |
42 | 37 |
|
43 | | -- Use react-native-reanimated and Skia for animations and drawing |
| 38 | +- Use react-native-reanimated and Skia for animations and drawing. |
44 | 39 | - Avoid thread jumping in animations to ensure smooth performance. |
45 | 40 |
|
46 | 41 | ### Avoid |
47 | 42 |
|
48 | 43 | - Avoid using `any` types. Always use specific types or interfaces. |
49 | 44 | - Avoid nesting ternary expressions. |
50 | 45 |
|
51 | | -# ------------------------------------------------------------------------------------------------- |
52 | | - |
53 | | -# PROJECT SPECIFIC INSTRUCTIONS |
54 | | - |
55 | | -# ------------------------------------------------------------------------------------------------- |
| 46 | +# ------------------- PROJECT-SPECIFIC INSTRUCTIONS ----------------------- |
0 commit comments