Default to using README.md instead of copilot-instructions.md #177628
Replies: 2 comments 2 replies
This comment was marked as off-topic.
This comment was marked as off-topic.
-
|
Currently, Copilot doesn’t natively default to using README.md instead of copilot-instructions.md. By design, copilot-instructions.md is treated as the primary AI-specific source of truth, while README.md is considered human-facing documentation. That said, there are some practical approaches if you want Copilot to prioritize README.md content: Manually include README.md in each session: You can add the file to the chat context when starting a session. This works but isn’t automated. Automation or wrapper scripts: You could implement a small wrapper or plugin for your IDE that automatically prepends the README.md content to every Copilot chat session. This effectively simulates a “default” behavior without modifying GitHub’s built-in handling. Merge or align content: If possible, consolidate the key instructions into the README.md so it contains all relevant information for both humans and AI. Then, your automation can feed the same source to Copilot, reducing the need to maintain both files. In short, there’s no built-in setting to default Copilot to README.md, but with tooling or workflow adjustments, you can achieve the effect you’re looking for—using README.md as the primary context while minimizing duplication and drift. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
Select Topic Area
Question
Copilot Feature Area
JetBrains & Xcode
Body
I work in an environment were we have a ton of projects. A lot of them have decent README.md files. For chat/agent mode, can we default (or have the option to default) copilot to reading those files? I know I can manually add the file as context for the chat session, but being able to default it would give a more seamless experience.
I understand that the README.md file is for humans, and copilot-instructions is for AI - but there is often duplicate information in both of them. Over time, the details of each drifts, even becoming contradicting, and it creates a maintenance headache and quite a bit of technical debt maintaining these two sources of truth over all of our projects.
Beta Was this translation helpful? Give feedback.
All reactions