-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Create github-copilot-custom-instructions.md #24
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
Closed
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
6754090
Create github-copilot-custom-instructions.md
rajbos ca860ea
Merge branch 'main' into main
aaronpowell a44a5ca
Updating filename
aaronpowell 4b1e384
Merge branch 'main' into main
aaronpowell 63bd403
Adding the .prompt to the filename
aaronpowell 86dad4c
Update prompts/github-copilot-custom-instructions.prompt.md
rajbos 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,18 @@ | ||
| --- | ||
| mode: "agent" | ||
| tools: ["codebase", "editFiles", "problems"] | ||
| description: "Create a GitHub Copilot Custom instructions file" | ||
| --- | ||
|
|
||
| # Create a GitHub Copilot Custom instructions file | ||
| Add a new or alter an existing custom instructions file for GitHub Copilot to help the Copilot to draft better suggestions and changes. Instructions for the custom instructions give additional information about the current programming languages / SDK's, or specific libraries used like for example the framework to use for the unit tests. | ||
|
|
||
| Include common coding instructions based on the code in the current repository, like: | ||
| - coding guidelines (might be in the README or CONTRIBUTING files) | ||
| - preferred ways of working | ||
| - folder structures if needed | ||
|
|
||
| A lot of models try to do to much in one go, as they are very eager to fix every problem they come across, so also include instructions to only make changes to code that is relevant for the change that is being made. The assistant should not change random code just because it has an issue. If the code has nothing to do with the current change it's trying to implement, it should not be changed. This goes for fixing issues, typos, or layout like indentation or new lines. Leave them alone and focus on the needed changes for the ask at hand. | ||
| Depending on the different programming environments and package managers, also add instructions to ignore changes to their temporary files, like for example build files, generated or downloaded binaries, or log and other output files. These should end up in the .gitnore file, but sometimes occur in agent mode as well, so best to have instructions to not commit those to the repository at all. | ||
|
|
||
| If you can find information about the runtime environment and possible limitations, add that information to the custom instructions file as well. | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This matches the title, it'd be preferable if they aren't the same.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any proposed text? I am blanking on how to differentiate 😄