Addressing feedback

This commit is contained in:
Aaron Powell
2026-02-02 14:01:22 +11:00
parent da3ef449a6
commit 54ce5c5603
11 changed files with 26 additions and 25 deletions

View File

@@ -79,7 +79,7 @@ go run <filename>.go
## Contributing ## Contributing
- Propose or add a new recipe by creating a markdown file in your language's `cookbook/` folder and a runnable example in `recipe/` - 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) - Follow repository guidance in [CONTRIBUTING.md](../../CONTRIBUTING.md)
## Status ## Status

View File

@@ -12,8 +12,8 @@ This folder hosts short, practical recipes for using the GitHub Copilot SDK with
## Contributing ## Contributing
Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../CONTRIBUTING.md). Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../../CONTRIBUTING.md).
## Status ## Status
This README is a scaffold; recipe files are placeholders until populated. These recipes are now complete and ready to use; the cookbook will continue to evolve as new scenarios are added.

View File

@@ -32,7 +32,7 @@ dotnet run
dotnet run -- --repo github/copilot-sdk dotnet run -- --repo github/copilot-sdk
``` ```
## Full example: Program.cs ## Full example: pr-visualization.cs
```csharp ```csharp
using System.Diagnostics; using System.Diagnostics;

View File

@@ -12,8 +12,8 @@ This folder hosts short, practical recipes for using the GitHub Copilot SDK with
## Contributing ## Contributing
Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../CONTRIBUTING.md). Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../../CONTRIBUTING.md).
## Status ## Status
This README is a scaffold; recipe files are placeholders until populated. These recipes are complete, practical examples and can be used directly or adapted for your own projects.

View File

@@ -26,13 +26,13 @@ go get github.com/github/copilot-sdk/go
```bash ```bash
# Auto-detect from current git repo # Auto-detect from current git repo
go run main.go go run pr-visualization.go
# Specify a repo explicitly # Specify a repo explicitly
go run main.go --repo github/copilot-sdk go run pr-visualization.go -repo github/copilot-sdk
``` ```
## Full example: main.go ## Full example: pr-visualization.go
```go ```go
package main package main

View File

@@ -12,7 +12,7 @@ This folder hosts short, practical recipes for using the GitHub Copilot SDK with
## Contributing ## Contributing
Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../CONTRIBUTING.md). Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../../CONTRIBUTING.md).
## Status ## Status

View File

@@ -29,13 +29,13 @@ npm install -D typescript tsx @types/node
```bash ```bash
# Auto-detect from current git repo # Auto-detect from current git repo
npx tsx pr-breakdown.ts npx tsx pr-visualization.ts
# Specify a repo explicitly # Specify a repo explicitly
npx tsx pr-breakdown.ts --repo github/copilot-sdk npx tsx pr-visualization.ts --repo github/copilot-sdk
``` ```
## Full example: pr-breakdown.ts ## Full example: pr-visualization.ts
```typescript ```typescript
#!/usr/bin/env npx tsx #!/usr/bin/env npx tsx

View File

@@ -54,7 +54,7 @@ npx tsx managing-local-files.ts
## Local SDK Development ## Local SDK Development
The `package.json` references the local Copilot SDK using `"file:../../.."`. This means: The `package.json` references the local Copilot SDK using `"*"`, which resolves to the local SDK source. This means:
- Changes to the SDK source are immediately available - Changes to the SDK source are immediately available
- No need to publish or install from npm - No need to publish or install from npm
@@ -63,7 +63,7 @@ The `package.json` references the local Copilot SDK using `"file:../../.."`. Thi
If you modify the SDK source, you may need to rebuild: If you modify the SDK source, you may need to rebuild:
```bash ```bash
cd ../../.. cd ../../src
npm run build npm run build
``` ```

View File

@@ -12,8 +12,8 @@ This folder hosts short, practical recipes for using the GitHub Copilot SDK with
## Contributing ## Contributing
Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../CONTRIBUTING.md). Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../../CONTRIBUTING.md).
## Status ## Status
This README is a scaffold; recipe files are placeholders until populated. These recipes are complete and ready to use; new contributions and additional recipes are welcome.

View File

@@ -27,13 +27,13 @@ pip install copilot-sdk
```bash ```bash
# Auto-detect from current git repo # Auto-detect from current git repo
python pr_breakdown.py python pr_visualization.py
# Specify a repo explicitly # Specify a repo explicitly
python pr_breakdown.py --repo github/copilot-sdk python pr_visualization.py --repo github/copilot-sdk
``` ```
## Full example: pr_breakdown.py ## Full example: pr_visualization.py
```python ```python
#!/usr/bin/env python3 #!/usr/bin/env python3
@@ -192,6 +192,7 @@ The current working directory is: {os.getcwd()}
session.send(prompt=user_input) session.send(prompt=user_input)
session.wait_for_idle() session.wait_for_idle()
session.destroy()
client.stop() client.stop()
if __name__ == "__main__": if __name__ == "__main__":

View File

@@ -48,13 +48,13 @@ python managing_local_files.py
## Local SDK Development ## Local SDK Development
The `requirements.txt` installs the local Copilot SDK using `-e ../..` (editable install). This means: The `requirements.txt` installs the Copilot SDK package from PyPI. This means:
- Changes to the SDK source are immediately available - You get the latest stable release of the SDK
- No need to publish or install from PyPI - No need to build from source
- Perfect for testing and development - Perfect for using the SDK in your projects
If you modify the SDK source, Python will automatically use the updated code (no rebuild needed). If you want to use a local development version, edit requirements.txt to use `-e ../..` for editable mode development.
## Python Best Practices ## Python Best Practices