-
Notifications
You must be signed in to change notification settings - Fork 8.4k
github: Add copilot-instructions.md #101442
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
Open
Thalley
wants to merge
1
commit into
zephyrproject-rtos:main
Choose a base branch
from
Thalley:copilot-review-file
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+20
−0
Open
Changes from all commits
Commits
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,20 @@ | ||
| # GitHub Copilot Instructions | ||
|
Check warning on line 1 in .github/copilot-instructions.md
|
||
|
|
||
| This project follows the coding and contribution guidelines outlined in the [Zephyr Project Documentation](https://docs.zephyrproject.org/latest/). GitHub Copilot should follow these principles when providing suggestions for code completion and reviews: | ||
|
|
||
| ## Coding Style and Guidelines | ||
| - Adhere to the coding style defined in the [Coding Guidelines](https://docs.zephyrproject.org/latest/contribute/coding_guidelines/index.html). | ||
| - Ensure code is formatted to meet these style requirements. | ||
| - Prefer functions and constructs defined in the guidelines. | ||
|
|
||
| ## Contribution Guidelines | ||
| - Follow the contribution process described in the [Contribution Guide](https://docs.zephyrproject.org/latest/contribute/index.html). | ||
| - Maintain consistency with existing code. | ||
| - Require commits to follow the format specified in the guidelines. | ||
|
|
||
| ## Key Practices for Copilot | ||
| - Prefer idiomatic Zephyr APIs and patterns where applicable. | ||
| - Use documentation examples as the default reference for common tasks. | ||
| - Avoid recommendations that diverge from the principles outlined in the Zephyr documentation. | ||
|
|
||
| For detailed standards, contributors are expected to review the latest version of the Zephyr Project documentation linked above. | ||
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.