Adds Copilot instructions #6787
Conversation
There was a problem hiding this comment.
@waldekmastykarz awesome work.
In general I don't have that much experience in this area (I only added cp-instructions to two other repos and most of the times I just left what copilot generated itself 😜) but I left some small comments/ideas that I had when comparing this file to other repos.
Please let me know what do you think about my feedback. It is more a open discussion or an idea we might consider now or later, not something that has to be updated or done 🙂
|
|
||
| ## References | ||
| - [Main README](../README.md) | ||
| - [Contributing Guide](../CONTRIBUTING.md) |
There was a problem hiding this comment.
I wonder if this is a good point of additional context for Copilot. TBH the contributing.md now is just a general page how to go about it on GH and with actually coding we should rather look for guidance at https://pnp.github.io/cli-microsoft365/contribute/contributing-guide
There was a problem hiding this comment.
Good point, let's update.
| - **Lint**: `npm run lint` (uses custom ESLint rules from `eslint-rules/`) | ||
| - **Watch**: `npm run watch` (TypeScript in watch mode) | ||
| - **Symlink for local CLI**: `npm link` (after build) | ||
| - **Node version**: Must be 22 (see `scripts/check-version.js`) |
There was a problem hiding this comment.
again I wonder if it is a huge benefit to specify the node version. For sure another place for us to remember
There was a problem hiding this comment.
It might be valuable in case someone runs into issues and they have no idea why. Aren't we updating it with find & replace?
| @@ -0,0 +1,57 @@ | |||
| # Copilot Instructions for CLI for Microsoft 365 | |||
There was a problem hiding this comment.
I wonder if it be worth adding a section like
## Useful Context in which we would specify perfect places to use as context for common operations that we may do in this repo.
For example:
- When creating a new command, always use guidance from https://pnp.github.io/cli-microsoft365/contribute/new-command/build-command-logic as your context
There was a problem hiding this comment.
I wonder if pointing Copilot at an existing command wouldn't be better reference than a human-friendly description we've got in our docs.
There was a problem hiding this comment.
Good idea, but we need to be sure the command is simple and up to date with our latest practicies
Co-authored-by: Adam Wójcik <58668583+Adam-it@users.noreply.github.com>
No description provided.