-
Notifications
You must be signed in to change notification settings - Fork 8
Add comprehensive GitHub Copilot instructions with emphasis on unit testing over full application runs #181
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
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 <[email protected]>
g1331
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
一般来说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 <[email protected]>
Updated the instructions to clarify when agents should run the full application. Added clear guidance that most development tasks don't require |
g1331
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
|
g1331
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
@copilot
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.