-
Notifications
You must be signed in to change notification settings - Fork 111
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
base: main
Are you sure you want to change the base?
Conversation
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.
Pull Request Overview
This PR adds a new custom instructions file for GitHub Copilot to guide code suggestions and enforce repository conventions.
- Introduces
prompts/github-copilot-custom-instructions.md
with front matter and detailed guidance. - Specifies coding guidelines, working practices, and file-ignore rules for Copilot.
@@ -0,0 +1,18 @@ | |||
--- | |||
mode: "ask, edit, agent" |
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.
Only one mode is supported per https://code.visualstudio.com/docs/copilot/copilot-customization#_prompt-file-structure
--- | ||
mode: "ask, edit, agent" | ||
tools: ["codebase", "editFiles", "problems"] | ||
description: "Create a GitHub Copilot Custom instructions file" |
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.
@aaronpowell in insiders now the team has a prompt built in so I don't think this is needed anymore. |
oh really? I must've missed that in the recent update notes. Got a link to the issue tracking it? |
This pull request introduces a new custom instructions file for GitHub Copilot, aimed at improving the quality and relevance of AI-generated suggestions. The file provides detailed guidance on coding practices, repository-specific conventions, and exclusions to ensure focused and meaningful changes.
Enhancements to GitHub Copilot Custom Instructions:
prompts/github-copilot-custom-instructions.md
: Added a new file to define custom instructions for GitHub Copilot, including guidelines for coding practices, preferred workflows, and repository-specific conventions. It also includes directives to avoid irrelevant changes, such as fixing unrelated issues or modifying temporary files.