feat(components): Co-Pilot Instructions First Pass

[scotttjob]

Motivations

Github Copilot has rolled out some new functionality to leverage a set of instructions on every prompt while working within a repository.

https://docs.github.com/en/copilot/customizing-copilot/adding-custom-instructions-for-github-copilot

This PR is a first-pass attempt at encoding some Atlantis-specific direction for Copilot to leverage.

I took a pass at high-level information as suggested by the documentation, then I worked with co-pilot a bit locally to format those steps into a format that it prefers (mainly added the bolding in the title, and formatting for the bullet points).

I then generated some changes along with the document to refine further (function over arrow definition, documentation for interface properties).

Very much open to feedback if you feel the instructions should include (or not include) any information.

Added

1. Github Copilot instructions

Testing

1. If you pull this branch down locally, and ask Copilot a question within vscode, it will automatically add the contents of copilot-instructions.md to your prompt.
2. There are instructions in the Github documentation above for enabling/disabling instructions within vscode, if you wanted to test toggling on and toggling off.

Changes can be
tested via Pre-release

---

In Atlantis we use Github's built in pull request reviews.

[chris-at-jobber]

Maybe "prefer HTML-native roles and attributes, and use ARIA roles only as necessary" or something? I guess "where applicable" already gets at that, but I wonder how the LLM reads that in practice (ie will it take that as a sign to prefer ARIA roles?)

[scotttjob]

Done!

[chris-at-jobber]

Is there a way to train it on our own guides for docs? Like

• reference [our docs guides](url to docs guides) when reviewing changes to documentation

[scotttjob]

Unfortunately not! They explicitly call that out as something that doesn't work: https://docs.github.com/en/copilot/customizing-copilot/adding-custom-instructions-for-github-copilot#writing-effective-custom-instructions

[cloudflare-workers-and-pages]

Deploying atlantis with    Cloudflare Pages

Latest commit:	5a08c1c
Status:	✅  Deploy successful!
Preview URL:	https://95896bd1.atlantis.pages.dev
Branch Preview URL:	https://scott-t-copilot-instructions.atlantis.pages.dev

View logs

[jdeichert]

Nice! I gave this a read and pulled it locally, my copilot picks it up when I ask questions related to the codebase 👍

It's difficult for me to understand whether we need more info here or not. It looks fine to me, but really it's hard to judge how well it works for copilot! 😅

Approved. We can always improve with more info over time.

[scotttjob]

Nice! I gave this a read and pulled it locally, my copilot picks it up when I ask questions related to the codebase 👍

It's difficult for me to understand whether we need more info here or not. It looks fine to me, but really it's hard to judge how well it works for copilot! 😅

Approved. We can always improve with more info over time.

Yeah it'll be interesting to keep an eye on it over time. I'd like to encourage the team to experiment with their own adjustments to it, and recommend changes if they find a new addition (or the removal of something in here) to be a useful change.