Skip to content

Commit 8938c61

Browse files
Copilotl0lawrence
andcommitted
Add comprehensive agents.md guide for using Copilot to fix CI issues
Co-authored-by: l0lawrence <[email protected]>
1 parent fbc4fb4 commit 8938c61

File tree

3 files changed

+455
-0
lines changed

3 files changed

+455
-0
lines changed

doc/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,9 @@ The folder structure is the following
77
- [dev](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev) : contains advanced documentation for _developers_ of SDK (not _consumers_ of SDK)
88

99
The file [eng_sys_checks](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md) is a read up as to what a standard `ci.yml` will actually execute.
10+
11+
## Quick Links for Common Tasks
12+
13+
- **Troubleshooting CI Failures**: See [Using Copilot Agents to Fix CI Issues](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/agents.md) for guidance on using GitHub Copilot to fix common PR issues
14+
- **Understanding CI Checks**: See [Engineering System Checks](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md)
15+
- **Developer Setup**: See [Developer Documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/README.md)

doc/dev/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ This folder contains documentation for developers of SDKs: internal teams at Mic
44

55
Overview of the documents:
66
- [Developer Set-Up](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/dev_setup.md) : How to create a development environment for this repo
7+
- [Using Copilot Agents to Fix CI Issues](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/agents.md): How to use GitHub Copilot to troubleshoot and fix common CI failures in your PRs
78
- [Release](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/release.md) : How to release a package when ready
89
- [Packaging](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/packaging.md) : How to organize packaging information for packages under `azure`
910
- [Testing](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/tests.md): How to write unit and functional tests for a library

0 commit comments

Comments
 (0)