✨ (chore): Introduced project instructions file to guide AI tooling and IDEs. #5038
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
approved
camilamacedo86
changed the title
camilamacedo86
force-pushed
the
add-copilot-instructions
branch
3 times, most recently
from
a815cd3 to
04fdca0
Compare
|
c/c @vitorfloriano |
camilamacedo86
force-pushed
the
add-copilot-instructions
branch
from
04fdca0 to
655fb21
Compare
vitorfloriano
left a comment
vitorfloriano
left a comment
There was a problem hiding this comment.
@camilamacedo86 I'm not sure if copilot-instructions.md will be considered by other AI tools.
For example, Gemini uses a file named GEMINI.md placed in root. Claude uses a CLAUDE.md file also placed in root.
It seems that there is no standard way of passing project instructions to AI. Some use .instructions.md or INSTRUCTIONS.md in root for that, but it's not a recognized practice.
| // SetTemplateDefaults implements machinery.Template | ||
| func (f *CopilotInstructions) SetTemplateDefaults() error { | ||
| if f.Path == "" { | ||
| f.Path = filepath.Join(".github", "copilot_instructions.md") |
There was a problem hiding this comment.
| f.Path = filepath.Join(".github", "copilot_instructions.md") | |
| f.Path = filepath.Join(".github", "copilot-instructions.md") |
|
Yep, I think might not be a good idea |
3 participants
This PR introduces Copilot-style instructions directly into the repository. While inspired by GitHub Copilot, these instructions are designed to be tool-agnostic, making them usable by a wide range of AI-assisted development tools and IDE integrations.
Benefits