-
Notifications
You must be signed in to change notification settings - Fork 0
Refactor: update README to enhance GitHub Copilot usage instructions … #6
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
Open
robpitcher
wants to merge
1
commit into
main
Choose a base branch
from
readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+24
−16
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -9,31 +9,39 @@ Choose one: | |||||
| Also required: | ||||||
| - Azure Subscription | ||||||
|
|
||||||
| ## Getting Started | ||||||
| ## Try it out | ||||||
|
|
||||||
| 1. Review the table below and the specific GitHub Copilot customizations used in this repo (located in `.github/` and `.vscode/mcp.json`) to get an idea of how these pieces work together to help you write Infrastructure as Code. | ||||||
| You can test the included GitHub Copilot customizations by using the included prompt template to create IaC for a VM: | ||||||
|
|
||||||
| ### GitHub Copilot Customizations | ||||||
| | Type | Location | When Used | Scope | Best For / Use Cases | | ||||||
| |------|----------|-----------|-------|----------------------| | ||||||
| | **Repository Instructions** | `.github/copilot-instructions.md` | Every chat/edit session | Entire repository | Global repo conventions, coding standards, guardrails that apply everywhere | | ||||||
| | **File/Path Instructions** | `.github/instructions/*.instructions.md` | Pattern/glob match (via `applyTo` frontmatter) | Specific files or paths | Language-specific rules (e.g., `**/*.bicep`, `**/*.tf`), framework guidelines | | ||||||
| | **Prompts** | `.github/prompts/*.prompt.md` | On-demand via `/` command | Single task | Reusable prompt templates, common tasks, onboarding workflows | | ||||||
| | **Agents** | `.github/agents/*.agent.md` | Invoked via Agent selector | Specialized persona | Domain experts; personas with specific knowledge/tools | | ||||||
| | **Skills** | `.github/skills/<name>/SKILL.md` | Automatic by agent | Task-specific capability | Custom tools, API integrations, deployment checks, doc lookups | | ||||||
| | **MCP Servers** | `mcp.json` | When configured & enabled | External tool integration | Connecting to external services (Azure, GitHub, databases, custom APIs) | | ||||||
| 1. Run `az login` to authenticate to Azure and select your desired subscription. | ||||||
|
|
||||||
| 2. Run `az login` to authenticate to Azure and select your desired subscription. | ||||||
| 2. Run the prompt template by typing `/demo-vm iacLanguage:bicep` or `/demo-vm iacLanguage:terraform` into GitHub Copilot Chat | ||||||
|
|
||||||
| 3. Run the prompt template by typing `/demo-vm iacLanguage:bicep` or `/demo-vm iacLanguage:terraform` into GitHub Copilot Chat | ||||||
| 3. Once GitHub Copilot has finished creating the IaC, you can ask it to run the deployment for you or follow the deployment instructions located in `infra/bicep/README.md` or `infra/terraform/README.md`. | ||||||
|
|
||||||
| 4. Once GitHub Copilot has finished creating the IaC, you can ask it to run the deployment for you or follow the deployment instructions located in `infra/bicep/README.md` or `infra/terraform/README.md`. | ||||||
| Want to learn how this repo guides Copilot? See the [Appendix: GitHub Copilot Customizations](#appendix-github-copilot-customizations). | ||||||
|
|
||||||
| ## Extras | ||||||
| Try a challenge task to reinforce the workflow: | ||||||
| Try creating IaC from your own prompts. | ||||||
|
|
||||||
| or | ||||||
|
|
||||||
| Try delegating IaC creation to GitHub Copilot Coding Agent: | ||||||
|
||||||
| Try delegating IaC creation to GitHub Copilot Coding Agent: | |
| Try delegating IaC creation to GitHub Copilot Coding Agent. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Missing period at the end of this sentence. The instruction should end with a period for consistency with other numbered steps.