Add comprehensive GitHub Copilot instructions with emphasis on unit testing over full application runs#181
Add comprehensive GitHub Copilot instructions with emphasis on unit testing over full application runs#181
Conversation
|
@g1331 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
…nds and timings Co-authored-by: g1331 <84710711+g1331@users.noreply.github.com>
g1331
left a comment
There was a problem hiding this comment.
一般来说agent都没有必要使用uv run main.py来运行整个框架,除非涉及到新插件开发 或者框架基础功能调整,如果要测试插件功能,尽量使用单元测试的方式
- Add warning that most development tasks don't need full app - Specify when to run uv run main.py (plugin dev, framework changes) - Prioritize unit tests for plugin functionality testing - Update manual testing workflow to emphasize unit tests first - Clarify quick start scripts are for deployment only Co-authored-by: g1331 <84710711+g1331@users.noreply.github.com>
Updated the instructions to clarify when agents should run the full application. Added clear guidance that most development tasks don't require |
|
This PR adds a comprehensive
.github/copilot-instructions.mdfile that provides detailed development instructions for GitHub Copilot coding agents working with the xiaomai-bot repository.Key Features
Validated Command Workflows: All commands have been tested in the actual environment with measured timing:
uv sync: 25-30 seconds (initial), 2-5 seconds (subsequent)uv run pytest tests/ -v: 2-3 seconds (30 tests)uv run ruff check .: <1 secondpre-commit run --all-files: 5-10 seconds after setupCritical Safety Features:
Complete Development Workflow:
uvClear Testing Guidelines (Updated based on feedback):
uv run pytest tests/test_plugin_name.py -vuv run pytestoveruv run main.pyfor validationImperative Instructions: Written in firm directive tone as requested:
Validation Process
Every command and workflow was manually tested to ensure:
The instructions enable any GitHub Copilot agent to immediately begin productive development work without trial-and-error command discovery, while following best practices for testing and validation.
Fixes #180.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.