Create comprehensive GitHub Copilot instructions for aztui development #29
Conversation
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
Copilot
AI
changed the title
[WIP] ✨Set up Copilot instructions
Create comprehensive GitHub Copilot instructions for aztui development
Aug 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added
.github/copilot-instructions.mdwith comprehensive instructions for GitHub Copilot coding agents working in the aztui codebase. The instructions provide all necessary information for a developer to effectively work with this Go-based Terminal User Interface (TUI) application for Azure resource management.Key Features
Firm Directive Structure: Instructions start with a clear directive to follow the provided guidance first before searching or using additional commands, ensuring consistent development practices.
Validated Commands: All commands and procedures have been thoroughly tested and validated, including:
make all(36s initial, 0.5s subsequent builds)make formatAZTUI_CONFIG_PATH=conf/default.yaml bin/aztuimake clean && make allCritical Timing Information: Includes explicit "NEVER CANCEL" warnings with specific timeout recommendations:
Prerequisites and Setup: Documents exact requirements including Go 1.19+, Azure CLI installation, and authentication requirements (
az login).Manual Validation Scenarios: Since the application is a TUI with no unit tests, provides specific manual testing procedures to validate changes, including startup testing and Azure CLI integration verification.
Repository Structure: Complete documentation of the codebase layout, key directories, and common file locations to help agents navigate efficiently.
Troubleshooting Guide: Covers common issues like authentication errors, build failures, and provides emergency recovery commands.
The instructions enable coding agents to work effectively with this Azure management tool without needing to discover build processes, dependencies, or validation procedures through trial and error.
Fixes #28.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.