Add comprehensive GitHub Copilot instructions for WxJava SDK development #3673
+198
−0
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.md
file that provides GitHub Copilot with detailed guidance on how to work effectively with the WxJava codebase. The instructions cover all essential aspects of development workflow for this WeChat Java SDK project.Key Features
Build and Validation Commands - All commands have been thoroughly tested and validated:
mvn clean compile -DskipTests=true --no-transfer-progress
(4-5 min initial, 50s incremental)mvn clean package -DskipTests=true --no-transfer-progress
(2-3 min initial, 1 min incremental)mvn checkstyle:check --no-transfer-progress
(~2 seconds)Critical Timing Information with "NEVER CANCEL" warnings:
Project Structure Guidance:
Development Workflow:
SDK Usage Patterns:
Validation
Every command and workflow described in the instructions has been tested on a fresh repository clone to ensure accuracy. The instructions follow the imperative tone requirement ("Run this command", "Do not do this") and provide complete command sequences that work reliably.
The file starts with a firm directive to always follow the instructions first before falling back to additional search and context gathering, as requested in the issue requirements.
Fixes #3672.
💡 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.