mirror of
https://github.com/github/awesome-copilot.git
synced 2026-02-20 18:35:14 +00:00
2a06b99b9b
Add a new cookbook recipe that generates WCAG accessibility reports using the Playwright MCP server. Includes streaming output, structured report formatting, and optional Playwright test generation. - C#, TypeScript, Python, and Go implementations - Markdown documentation for each language - Updated cookbook.yml, copilot-sdk README, and package.json
95 lines
4.7 KiB
Markdown
95 lines
4.7 KiB
Markdown
# GitHub Copilot SDK Cookbook
|
||
|
||
This cookbook collects small, focused recipes showing how to accomplish common tasks with the GitHub Copilot SDK across languages. Each recipe is intentionally short and practical, with copy‑pasteable snippets and pointers to fuller examples and tests.
|
||
|
||
## Recipes by Language
|
||
|
||
### .NET (C#)
|
||
|
||
- [Ralph Loop](dotnet/ralph-loop.md): Build autonomous AI coding loops with fresh context per iteration, planning/building modes, and backpressure.
|
||
- [Error Handling](dotnet/error-handling.md): Handle errors gracefully including connection failures, timeouts, and cleanup.
|
||
- [Multiple Sessions](dotnet/multiple-sessions.md): Manage multiple independent conversations simultaneously.
|
||
- [Managing Local Files](dotnet/managing-local-files.md): Organize files by metadata using AI-powered grouping strategies.
|
||
- [PR Visualization](dotnet/pr-visualization.md): Generate interactive PR age charts using GitHub MCP Server.
|
||
- [Persisting Sessions](dotnet/persisting-sessions.md): Save and resume sessions across restarts.
|
||
- [Accessibility Report](dotnet/accessibility-report.md): Generate WCAG accessibility reports using the Playwright MCP server.
|
||
|
||
### Node.js / TypeScript
|
||
|
||
- [Ralph Loop](nodejs/ralph-loop.md): Build autonomous AI coding loops with fresh context per iteration, planning/building modes, and backpressure.
|
||
- [Error Handling](nodejs/error-handling.md): Handle errors gracefully including connection failures, timeouts, and cleanup.
|
||
- [Multiple Sessions](nodejs/multiple-sessions.md): Manage multiple independent conversations simultaneously.
|
||
- [Managing Local Files](nodejs/managing-local-files.md): Organize files by metadata using AI-powered grouping strategies.
|
||
- [PR Visualization](nodejs/pr-visualization.md): Generate interactive PR age charts using GitHub MCP Server.
|
||
- [Persisting Sessions](nodejs/persisting-sessions.md): Save and resume sessions across restarts.
|
||
- [Accessibility Report](nodejs/accessibility-report.md): Generate WCAG accessibility reports using the Playwright MCP server.
|
||
|
||
### Python
|
||
|
||
- [Ralph Loop](python/ralph-loop.md): Build autonomous AI coding loops with fresh context per iteration, planning/building modes, and backpressure.
|
||
- [Error Handling](python/error-handling.md): Handle errors gracefully including connection failures, timeouts, and cleanup.
|
||
- [Multiple Sessions](python/multiple-sessions.md): Manage multiple independent conversations simultaneously.
|
||
- [Managing Local Files](python/managing-local-files.md): Organize files by metadata using AI-powered grouping strategies.
|
||
- [PR Visualization](python/pr-visualization.md): Generate interactive PR age charts using GitHub MCP Server.
|
||
- [Persisting Sessions](python/persisting-sessions.md): Save and resume sessions across restarts.
|
||
- [Accessibility Report](python/accessibility-report.md): Generate WCAG accessibility reports using the Playwright MCP server.
|
||
|
||
### Go
|
||
|
||
- [Ralph Loop](go/ralph-loop.md): Build autonomous AI coding loops with fresh context per iteration, planning/building modes, and backpressure.
|
||
- [Error Handling](go/error-handling.md): Handle errors gracefully including connection failures, timeouts, and cleanup.
|
||
- [Multiple Sessions](go/multiple-sessions.md): Manage multiple independent conversations simultaneously.
|
||
- [Managing Local Files](go/managing-local-files.md): Organize files by metadata using AI-powered grouping strategies.
|
||
- [PR Visualization](go/pr-visualization.md): Generate interactive PR age charts using GitHub MCP Server.
|
||
- [Persisting Sessions](go/persisting-sessions.md): Save and resume sessions across restarts.
|
||
- [Accessibility Report](go/accessibility-report.md): Generate WCAG accessibility reports using the Playwright MCP server.
|
||
|
||
## How to Use
|
||
|
||
- Browse your language section above and open the recipe links
|
||
- Each recipe includes runnable examples in a `recipe/` subfolder with language-specific tooling
|
||
- See existing examples and tests for working references:
|
||
- Node.js examples: `nodejs/examples/basic-example.ts`
|
||
- E2E tests: `go/e2e`, `python/e2e`, `nodejs/test/e2e`, `dotnet/test/Harness`
|
||
|
||
## Running Examples
|
||
|
||
### .NET
|
||
|
||
```bash
|
||
cd dotnet/cookbook/recipe
|
||
dotnet run <filename>.cs
|
||
```
|
||
|
||
### Node.js
|
||
|
||
```bash
|
||
cd nodejs/cookbook/recipe
|
||
npm install
|
||
npx tsx <filename>.ts
|
||
```
|
||
|
||
### Python
|
||
|
||
```bash
|
||
cd python/cookbook/recipe
|
||
pip install -r requirements.txt
|
||
python <filename>.py
|
||
```
|
||
|
||
### Go
|
||
|
||
```bash
|
||
cd go/cookbook/recipe
|
||
go run <filename>.go
|
||
```
|
||
|
||
## Contributing
|
||
|
||
- Propose or add a new recipe by creating a markdown file in your language's `cookbook/` folder and a runnable example in `recipe/`
|
||
- Follow repository guidance in [CONTRIBUTING.md](../../CONTRIBUTING.md)
|
||
|
||
## Status
|
||
|
||
Cookbook structure is complete with 7 recipes across all 4 supported languages. Each recipe includes both markdown documentation and runnable examples.
|