GitHub Spec Kit is a comprehensive toolkit for implementing Spec-Driven Development (SDD) - a methodology that emphasizes creating clear specifications before implementation. The toolkit includes templates, scripts, and workflows that guide development teams through a structured approach to building software. Specify CLI is the command-line interface that bootstraps projects with the Spec Kit framework. It sets up the necessary directory structures, templates, and AI agent integrations to support the Spec-Driven Development workflow. The toolkit supports multiple AI coding assistants, allowing…
The Awesome GitHub Copilot repository is a community-driven collection of custom agents and instructions designed to enhance GitHub Copilot experiences across various domains, languages, and use cases. The project includes: All agent files (.agent.md) and instruction files (.instructions.md) must include proper markdown front matter. Agent Skills are folders containing a SKILL.md file with frontmatter and optional bundled assets. Hooks are folders containing a README.md with frontmatter and a hooks.json configuration file:
These pointers tell agents where the user's personal context files live. Read only the file(s) needed to answer a question; do not load all of them by default. Run the setup-my-iq skill to populate these context files (or fill them in manually). Once they exist, update each @<path> pointer below to reference the real location. - identityProfile — name, role, org, team, manager, what the user does, what people come to them for. @<CONTEXT_DIR>/identity.md - roleAndResponsibilities — responsibilities per team,…
{% data reusables.rai.copilot.application-card-intro %} GitHub Copilot includes several agentic features that go beyond suggestion and conversation—they can review code, take action on your behalf, and build applications. This card covers…
Quick purpose: Help contributors and AI coding agents quickly understand this mono-repo and be productive (build, test, add SDK features, add E2E tests). ✅ <SDK_ROOT> means this directory, whether it is checked out as a standalone repository or nested under another repository. - Start with SDK development setup for layout-specific prerequisites and dependency preparation; select only the languages needed. - Monorepo helpers: use the portable package scripts from <SDKROOT>: - Build all six SDKs: npm --prefix <SDKROOT> run build -…
This style guide applies to all documentation in the docs/ directory. These docs are synced to github/docs-internal via a normalization pipeline, so they must follow the conventions below to be compatible with docs.github.com. Use sentence case for all headings. Capitalize only the first word and proper nouns. Use and instead of & in headings. Do not use bold or italic markers inside headings. The heading level provides emphasis. Use GitHub-flavored alert syntax: Never use > Note: or > Tip: style…
This directory is the Java SDK's Maven reactor. Paths and commands below are relative to this directory, whether it is nested at src/sdk/java or exported as java. Keep API usage examples in README.md, the SDK documentation, and public Javadoc rather than duplicating them in these contributor instructions. - sdk/src/main/java/ contains the handwritten client, session, and RPC APIs. sdk/src/test/java/ contains unit and integration tests. - sdk/src/generated/java/ contains generated protocol and event types. - copilot-native/ packages platform-specific runtime artifacts separately from the…
This directory contains the independent github-copilot-sdk crate. In standalone SDK workflows, paths and Cargo commands below are relative to this directory, and this crate's own lockfile and toolchain apply. When nested at src/sdk/rust, the runtime CLI consumes the same checked-out sources through the Bazel integration described under Development. The runtime's N-API architecture does not otherwise govern this crate. - Use the existing Error and ErrorKind in src/errors.rs. Extend that public error contract instead of adding parallel per-module error types or…
This is a CodeQL extractor that maps a language's parse tree onto a shared AST using the yeast desugaring engine. Swift, the only language so far, is parsed by Apple's swift-syntax rather than by tree-sitter. - The raw parse tree's shape is described by extractor/swiftnodetypes.yml, which is generated from swift-syntax by swift-syntax-rs/schemagen. Do not edit it by hand; regenerate it with scripts/regenerate-node-types.sh after changing the pinned swift-syntax version, then review the diff alongside the mapping in extractor/src/languages/swift/swift.rs. - To run…
GitHub Agentic Workflows (gh-aw) is a GitHub CLI extension that compiles markdown workflows into GitHub Actions. To keep first-turn context small, only these repository root instruction files should be considered ambient: Everything else should be loaded lazily through skills only when needed. Workflows that declare a source: frontmatter entry (for example source: githubnext/agentic-ops@<ref>) are provenance-managed from an upstream bundle. Use skills only when the task requires specialized guidance. Do not pre-load every skill. All skills are local to this repository…
A GitHub CLI (gh) extension for managing stacked branches and pull requests. Written in Go, it automates creating branches, keeping them rebased, setting PR base branches, and navigating between stack layers. Always run go vet before go test. CI runs both on every push/PR across ubuntu, windows, and macOS (test.yml). There is no Makefile, linter config, or code generation step. The standard Go toolchain is all that's needed. Each command lives in its own file (cmd/<name>.go) and follows this pattern:
This file applies to the entire repository. It is the repository-specific instruction source for coding agents and automated contributors. Keep this file durable, small, and focused on rules that should apply every time work happens in this repository. Do not add one-off task plans, temporary investigation notes, local machine details, or long procedure transcripts here. Move detailed operating procedures to docs/, reusable workflows to skills, and directory-specific rules to a closer nested AGENTS.md if that scope ever appears. Codex loads…
Quick reference for AI agents working with MCP Gateway (Go-based MCP proxy server). Install: make install (install toolchains and dependencies) Build: make build (builds awmg binary) Test: make test (run unit tests, no build required) Test-Unit: make test-unit (run unit tests only) Test-Integration: make test-integration (run binary integration tests, auto-builds binary if not present) Test-All: make test-all (run both unit and integration tests; always builds the binary first) Test-CI: make test-ci (unit tests with coverage and JSON output for CI)…
Write Go that follows the Google Go Style Guide and lines up with cli/cli conventions. Keep it readable and simple. Doc comments earn their keep by saying something the code doesn't. Skip: When in doubt, fewer words. If a comment reads like marketing or a victory lap, delete it. There are two test layers with different guarantees. Put a test in the cheapest layer that can actually prove the thing, and don't restate the same claim in both. - Go…
GitHub Agentic Workflows is a Go-based GitHub CLI extension for writing agentic workflows in natural language using markdown files, running them as GitHub Actions. gh-aw is a GitHub CLI extension (gh aw) that compiles markdown workflows into GitHub Actions. It is not the GitHub Copilot CLI (copilot command). While workflows can use the Copilot CLI as an AI engine, gh-aw itself is a separate tool for workflow management and compilation. BE LAZY: Skills in skills/ provide detailed, specialized knowledge about…
GitHubAGENTS.md