Skip to content

docs: add comprehensive GitHub Copilot instructions with uv and semantic commit guidelines#873

Merged
wanghan-iapcm merged 5 commits intodevelfrom
copilot/fix-872
Aug 29, 2025
Merged

docs: add comprehensive GitHub Copilot instructions with uv and semantic commit guidelines#873
wanghan-iapcm merged 5 commits intodevelfrom
copilot/fix-872

Conversation

Copy link
Contributor

Copilot AI commented Aug 26, 2025

This PR adds a comprehensive .github/copilot-instructions.md file 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:

  • Uses uv pip install for all package installations instead of pip
  • Provides faster and more reliable dependency management
  • Includes troubleshooting for network timeouts and installation issues

Semantic Commit Guidelines:

  • Enforces semantic commit message format: type(scope): description
  • Defines commit types: feat, fix, docs, style, refactor, test, chore
  • Requires semantic format for both commits and PR titles
  • Provides clear examples for different scenarios

Core Development Workflow:

  • Step-by-step installation process using uv
  • Test execution commands with timing expectations (~10 seconds for full suite)
  • Linting and formatting using ruff with "NEVER CANCEL" warnings
  • Documentation build process using Sphinx

Validated Commands:
All commands have been tested and validated:

  • CLI functionality (dpdata --version, dpdata --help)
  • Test suite execution (python -m unittest discover)
  • Individual test modules (python -m unittest test_<module>.py)
  • Code quality tools (ruff check, ruff format)
  • Coverage reporting

Key Features:

  • Imperative tone throughout with clear directives
  • Timing expectations for all operations
  • Comprehensive troubleshooting section
  • Repository structure overview
  • Format-specific development workflows
  • Clear validation scenarios for testing changes

Additional Improvements:

  • Updated .gitignore to exclude test artifacts (tests/data_*, tests/tmp.*, tests/.coverage)
  • Documented core vs optional dependency relationships
  • Included guidance for plugin development

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.

Copilot AI and others added 2 commits August 26, 2025 04:50
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
Copilot AI requested a review from njzjz August 26, 2025 04:56
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@robinzyb It seems you accidentally committed this file in #446. Copilot found and removed it.

…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
Copilot AI requested a review from njzjz August 26, 2025 05:07
@njzjz
Copy link
Member

njzjz commented Aug 26, 2025

pre-commit.ci autofix

@codecov
Copy link

codecov bot commented Aug 26, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.47%. Comparing base (5f1dec8) to head (b907a88).
⚠️ Report is 28 commits behind head on devel.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@njzjz njzjz marked this pull request as ready for review August 26, 2025 05:19
@njzjz njzjz requested a review from wanghan-iapcm August 26, 2025 05:19
@wanghan-iapcm wanghan-iapcm merged commit ebb20ad into devel Aug 29, 2025
20 of 23 checks passed
@wanghan-iapcm wanghan-iapcm deleted the copilot/fix-872 branch August 29, 2025 03:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature Request] Set up Copilot instructions

3 participants