pnp
Update copilot-instructions.md to be more helpful for GitHub Copilot Agent
Based on my experience from the first issue we assigned to GitHub Copilot agent https://github.com/pnp/vscode-viva/pull/563 I noticed we could add some more information to copilot-instructions.md to be more useful for GH Copilot Agent. We could do a bit of research but things I would already add and point out are:
- always use contributing.md as context
- always open a PR that targets
devbranch and any changes should start fromdevbranch - never update
npm-shrinkwrap.jsonunless you are adding a new dependency, but then I would not trust any Copilot agent to just pick a new npm package to add to our project. So I would say Copilot agent should never introduce any new npm packages to our repo
in the latest release of VS Code we may also consider adding Agents.md which stores dedicated instructions for agents and not for user run prompts for the repo
@Saurabh7019, @nicodecleyre would you like to add anything before we open it up? I suggest we should focus on the following:
- clarify that GH Copilot Agent should always use and check the contribution guide from
contribution.mdfile before starting work - clarify that all new features should start from
devbranch and PRs should targetdevbranch... and NOOOOOTmain - do not update
npm-shrinkwrap.jsonunless some new npm package is added topackage.jsonbut I would suggest GitHub Copilot should NOT decide it on its own
looks good to me for now. I guess improving instructions would be an on-going work as we let Copilot work on more issues.
