docs: add comprehensive GitHub Copilot instructions and environment setup#4911
Merged
docs: add comprehensive GitHub Copilot instructions and environment setup#4911
Conversation
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] [Feature Request] Set up Copilot environments and instructions
Add comprehensive GitHub Copilot instructions for DeePMD-kit development
Aug 24, 2025
njzjz
requested changes
Aug 24, 2025
…emp files Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Copilot
AI
changed the title
Add comprehensive GitHub Copilot instructions for DeePMD-kit development
Add comprehensive GitHub Copilot instructions and environment setup for DeePMD-kit
Aug 24, 2025
Member
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
njzjz
reviewed
Aug 24, 2025
njzjz
reviewed
Aug 24, 2025
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Copilot
AI
changed the title
Add comprehensive GitHub Copilot instructions and environment setup for DeePMD-kit
docs: add comprehensive GitHub Copilot instructions and environment setup
Aug 24, 2025
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Member
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive GitHub Copilot development support for the DeePMD-kit codebase, including detailed instructions and automated environment setup to help Copilot agents work effectively.
- Complete development workflow documentation with precise timing expectations and build instructions
- Automated GitHub Actions workflow for environment setup with dependency management
- Testing guidance emphasizing single test execution over full test suites for faster iteration
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
.github/copilot-instructions.md |
Comprehensive documentation covering build processes, testing strategies, validation scenarios, and development workflows with specific timing expectations |
.github/workflows/copilot-setup-steps.yml |
Automated environment setup workflow that pre-configures Python environment, installs dependencies, builds the package, and validates installation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## devel #4911 +/- ##
==========================================
- Coverage 84.29% 84.29% -0.01%
==========================================
Files 702 702
Lines 68664 68665 +1
Branches 3573 3573
==========================================
Hits 57882 57882
- Misses 9642 9643 +1
Partials 1140 1140 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
iProzd
approved these changes
Aug 25, 2025
ChiahsinChu
pushed a commit
to ChiahsinChu/deepmd-kit
that referenced
this pull request
Dec 17, 2025
…etup (deepmodeling#4911) This PR adds comprehensive development support for GitHub Copilot agents working in the DeePMD-kit codebase. ## What's included **Comprehensive Copilot Instructions (`.github/copilot-instructions.md`)** - Complete build workflow with exact timing expectations (67s Python build, 164s C++ build) - Virtual environment setup and dependency installation for all backends (TensorFlow, PyTorch, JAX, Paddle) - **Optimized testing guidance**: Emphasizes single test execution (~8-13 seconds) over full test suite (60+ minutes) for faster development feedback - Linting and formatting with ruff (1 second execution) - Multiple validation scenarios for CLI, Python interface, and training workflows - Directory structure reference and key file locations - Critical warnings with specific timeout recommendations to prevent premature cancellation - **Conventional commit specification**: Guidelines for commit messages and PR titles following `type(scope): description` format **Automated Environment Setup (`.github/workflows/copilot-setup-steps.yml`)** - Pre-configures Python environment using uv for fast dependency management - Installs TensorFlow CPU and PyTorch automatically - Builds the DeePMD-kit package with all dependencies - Sets up pre-commit hooks for code quality - Validates installation to ensure environment readiness **Development Efficiency Features** - All commands tested and validated with accurate timing measurements - Imperative tone throughout for clear action items - Copy-paste ready validation scenarios - Gitignore rules to prevent temporary test files from being committed ## Key improvements for Copilot agents - **Faster iteration**: Single test recommendations instead of 60+ minute full test suites - **Automated setup**: No manual environment configuration needed - **Precise expectations**: Exact timing guidance prevents timeout issues during builds - **Multi-backend support**: Complete coverage of TensorFlow, PyTorch, JAX, and Paddle workflows - **Consistent commit standards**: Enforces conventional commit specification for all changes The instructions enable any GitHub Copilot agent to work effectively in this codebase from a fresh clone with precise expectations for build times, test execution, and validation workflows. Fixes deepmodeling#4910. <!-- START COPILOT CODING AGENT TIPS --> --- 💡 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](https://gh.io/copilot-coding-agent-tips) in the docs. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@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.
This PR adds comprehensive development support for GitHub Copilot agents working in the DeePMD-kit codebase.
What's included
Comprehensive Copilot Instructions (
.github/copilot-instructions.md)type(scope): descriptionformatAutomated Environment Setup (
.github/workflows/copilot-setup-steps.yml)Development Efficiency Features
Key improvements for Copilot agents
The instructions enable any GitHub Copilot agent to work effectively in this codebase from a fresh clone with precise expectations for build times, test execution, and validation workflows.
Fixes #4910.
💡 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.