-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add copilot instructions #46
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| Welcome, Copilot! This file provides context and coding guidelines for assisting with this React Native project. Instructions are divided | ||
| into two sections: General Instructions and Project-Specific Instructions. General Instructions are shared across all projects within the | ||
| RN team and include best practices applicable across projects. These should be updated via PRs to RN project template. | ||
|
|
||
| When thinking of solutions, combine general instructions and project-specific instructions. However, project-specific instructions take | ||
| precedence and can override general instructions. Project-specific instructions are tailored to the specific needs of the project and are | ||
| updated throughout the development process. | ||
|
|
||
| # ------------------------ GENERAL INSTRUCTIONS ------------------------ | ||
|
|
||
| ### About | ||
|
|
||
| - This is a React Native app built with Expo and TypeScript. | ||
| - The project uses pnpm as its package manager. | ||
|
|
||
| ### Code Quality Tools | ||
|
|
||
| - The project uses ESLint and Prettier for auto-formatting and enforcing coding rules. | ||
| - Write unit tests using `jest` and `@testing-library/react-native`. | ||
| - Write E2E tests using Maestro. | ||
|
|
||
| ### Code Style | ||
|
|
||
| - Prefer destructuring for props and objects. | ||
| - Use modern TypeScript syntax and features. | ||
| - Use arrow functions for components. | ||
| - Avoid deprecated or legacy APIs. | ||
| - Use `async/await` for asynchronous operations. | ||
|
|
||
| ### Preferred Modules and Libraries | ||
|
|
||
| - Use `expo-router` for navigation. | ||
| - Prefer the usage of Expo libraries when available. | ||
|
|
||
| ### Chat and Communication | ||
|
|
||
| - When suggesting code changes in chat, ensure imports are included at the top of the file. | ||
|
|
||
| ### Animations | ||
|
|
||
| - Use react-native-reanimated and Skia for animations and drawing. | ||
| - Avoid thread jumping in animations to ensure smooth performance. This means, try to access .value of sharedValue in worklets, not on JS thread. | ||
|
|
||
| ### Avoid | ||
|
|
||
| - Avoid using `any` types. Always use specific types or interfaces. | ||
| - Avoid nesting ternary expressions. | ||
|
|
||
| # ------------------- PROJECT-SPECIFIC INSTRUCTIONS ----------------------- | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I added some basic setup based on wha we have in project and what you shared @pchalupa . But its all open for discussion what should be actually shared across team |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.