-
-
Notifications
You must be signed in to change notification settings - Fork 41
chore: add copilot-instructions.md for the repo #488
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
Conversation
|
Do you know if Copilot supports agents.md? The idea would be to make it more compatible and not Copilot-specific. For example, I’ve been using GPT Codex lately, and it seems to me that agents.md is advocating for creating generalized instructions for all agents rather than specific ones for each. (I find it more convenient if each developer can use the agent they prefer). On https://agents.md/ page says that Copilot is compatible, but I’ don't know how to test it, I don’t have experience with Copilot. Could you try it? |
What Copilot understands today
After looking a lot for it, this is what it supports. I generated it, but I can't test it @antonio-gg-dev can you test it and try it? and improve it if need it? |
antonio-gg-dev
left a comment
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.
Working in Codex 👍🏻
Chemaclass
left a comment
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.
Thanks! Good from my side. Feel free to merge after the CI is green 🥳
|
@evalverde-vw Out of curiousity: does the |
|
@evalverde-vw And another question: was the |
@carlfriedrich it comes from my experience with LLM hallucination, so I started forcing them to have a "dump file" that forced them to keep the context, as well as a structure, that could help them in case the task needed to be re-worked.
@carlfriedrich |
📚 Description
Introduce a comprehensive
copilot-instructions.mdtailored for bashunit and our TDD-first workflow. It formalizes the./tasks/workflow (one file per change:YYYY-MM-DD-slug.md), enforces ADR reading/creation rules, and adds a label so DeepWiki can continuously scrape and keep the repository documentation up to date.This PR is documentation/process-only; it makes no behavioral changes to the library itself.
🔖 Changes
Add
copilot-instructions.mdat the repo root (English)Define strict TDD workflow and task files convention:
./tasks/with per-change files namedYYYY-MM-DD-slug.md.Add
.gitignoreentries:/.task/→ not versioned.Clarify ADR policy:
/ADR/and match existing ADR formatting.Include verified bashunit test examples (taken from actual repo patterns) in the instructions—no hypothetical snippets.
Document Definition of Done: all tests green for the right reason, lint/format clean, docs updated.
Add DeepWiki label/tag (e.g.,
deepwiki:track) to enable automated scraping/refresh of repository knowledge.✅ To-do list
CHANGELOG.mdto reflect the new feature or fix