Skip to content
Prompt

AKS — Copilot Instructions

by Azure

AI Summary

This booster provides GitHub Copilot with structured instructions for navigating the Azure Kubernetes Service repository, including standards, conventions, and links to module-specific and file-specific guidance. It benefits AKS team members and contributors working within the repository who use Copilot for code generation and documentation tasks.

Install

Copy this and paste it into Claude Code, Cursor, or any AI assistant:

I want to add the "AKS — Copilot Instructions" prompt rules to my project.
Repository: https://github.com/Azure/AKS

Please read the repo to find the rules/prompt file, then:
1. Download it to the correct location (.cursorrules, .windsurfrules, .github/prompts/, or project root — based on the file type)
2. If there's an existing rules file, merge the new rules in rather than overwriting
3. Confirm what was added

Description

Azure Kubernetes Service

Repository Overview

This repository contains resources, examples, and documentation for the Azure Kubernetes Service (AKS) Engineering team: • Production Website: <https://blog.aks.azure.com> (Docusaurus blog in website/) • Examples: Real-world AKS scenarios, troubleshooting guides, and configurations • VHD Notes: Node image release notes for AKS Ubuntu, Windows, Mariner, and Azure Linux • AI Conformance: AKS service version compliance profiles • Community: Open-source collaboration with AKS users and contributors Repository Structure `text AKS/ ├── .github/ │ ├── copilot-instructions.md # This file (repo-wide standards) │ └── instructions/ # File-specific patterns │ └── website.blog.instructions.md # Blog post guidelines ├── website/ # Docusaurus blog site │ ├── AGENTS.md # Website module guide │ ├── blog/ # Blog posts │ ├── src/ # React components │ └── package.json ├── examples/ # AKS configuration examples │ ├── fleet/ # Azure Kubernetes Fleet Manager │ ├── istio-based-service-mesh/ # Service mesh examples │ ├── kube-prometheus/ # Monitoring setup │ └── vnet/ # Networking examples ├── vhd-notes/ # Node image release notes │ ├── aks-ubuntu/ │ ├── AKSMariner/ │ ├── AKSWindows/ │ └── AzureLinux/ ├── README.md └── LICENSE.MD ` ---

Check prerequisites

if ! command -v kubectl &> /dev/null; then echo "Error: kubectl not found" >&2 exit 1 fi

AKS Repository - GitHub Copilot Instructions

> Scope: Repository-wide standards, conventions, and Microsoft style guide. > Module-Specific: See AGENTS.md files in subdirectories. > File-Specific: See .github/instructions/*.instructions.md for targeted patterns. ---

Code Style and File Naming

Code Style • Markdown: Follow CommonMark spec • YAML: 2-space indentation, no tabs • Shell scripts: Use shellcheck-compliant bash with set -euo pipefail • TypeScript: Follow TypeScript ESLint recommended rules • React: Functional components with hooks (no class components) File Naming | Type | Convention | Example | |:---|:---|:---| | Markdown | kebab-case.md | getting-started.md | | TypeScript/React components | PascalCase.tsx | BlogPost.tsx | | TypeScript utilities | camelCase.ts | analytics.ts | | CSS | kebab-case.css or ComponentName.module.css | blog-post.module.css | | YAML | kebab-case.yaml or .yml | deployment.yaml | | Shell scripts | kebab-case.sh | remediate.sh | | VHD notes | YYYYMMDD.VV.V.txt | 202401.03.0.txt | ---

Discussion

0/2000
Loading comments...

Health Signals

MaintenanceCommitted 1mo ago
Active
Adoption1K+ stars on GitHub
2.1k ★ · Popular
DocsMissing or thin
Undocumented

GitHub Signals

Stars2.1k
Forks358
Issues421
Updated1mo ago
View on GitHub
MIT License

My Fox Den

Community Rating

Sign in to rate this booster

Works With

Any AI assistant that accepts custom rules or system prompts

Claude
ChatGPT
Cursor
Windsurf
Copilot
+ more