docs: add comprehensive GitHub Copilot instructions with uv and semantic commit guidelines#873
Merged
wanghan-iapcm merged 5 commits intodevelfrom Aug 29, 2025
Merged
docs: add comprehensive GitHub Copilot instructions with uv and semantic commit guidelines#873wanghan-iapcm merged 5 commits intodevelfrom
wanghan-iapcm merged 5 commits intodevelfrom
Conversation
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
…ommands Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] [Feature Request] Set up Copilot instructions
Add comprehensive GitHub Copilot instructions for dpdata repository
Aug 26, 2025
njzjz
requested changes
Aug 26, 2025
Member
…uidelines Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Copilot
AI
changed the title
Add comprehensive GitHub Copilot instructions for dpdata repository
docs: add comprehensive GitHub Copilot instructions with uv and semantic commit guidelines
Aug 26, 2025
njzjz
approved these changes
Aug 26, 2025
Member
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## devel #873 +/- ##
=======================================
Coverage 85.47% 85.47%
=======================================
Files 82 82
Lines 7675 7675
=======================================
Hits 6560 6560
Misses 1115 1115 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
wanghan-iapcm
approved these changes
Aug 29, 2025
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.
This PR adds a comprehensive
.github/copilot-instructions.mdfile that provides GitHub Copilot coding agents with detailed guidance on how to work effectively in the dpdata repository.The instructions include:
Package Management with uv:
uv pip installfor all package installations instead of pipSemantic Commit Guidelines:
type(scope): descriptionCore Development Workflow:
Validated Commands:
All commands have been tested and validated:
dpdata --version,dpdata --help)python -m unittest discover)python -m unittest test_<module>.py)ruff check,ruff format)Key Features:
Additional Improvements:
.gitignoreto exclude test artifacts (tests/data_*,tests/tmp.*,tests/.coverage)The instructions follow GitHub Copilot's expected format with firm directives to reference them first before falling back to search or bash commands.
Fixes #872.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.