Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds GitHub Copilot “skills” documentation to help contributors follow established project patterns (CI debugging, writing samples, and keeping sync/async implementations mirrored), and aligns CI formatting/lint ordering with the guidance.
Changes:
- Reordered the CI workflow to run black before pylint/mypy.
- Added three Copilot skill guides: CI failure debugging, sample authoring, and the sync/async mirroring pattern.
- Updated Copilot instructions to emphasize running black before pylint/mypy and to codify “new feature” expectations (sample + tests).
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/validate.yml | Moves black earlier in the validation sequence (before pylint/mypy). |
| .github/skills/sync-async-pattern/SKILL.md | Documents the repo’s sync/async mirroring approach and key implementation patterns. |
| .github/skills/samples/SKILL.md | Defines conventions and guidance for creating/updating samples (including lint expectations). |
| .github/skills/ci-failure-debugging/SKILL.md | Provides a step-by-step guide to reproduce and fix CI failures locally. |
| .github/copilot-instructions.md | Updates Copilot guidance to run black first and to require samples + tests for new features. |
You can also share your feedback on Copilot code review. Take the survey.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adding copilot skills to:
Contribution checklist:
General Guidelines and Best Practices