-
Notifications
You must be signed in to change notification settings - Fork 59
docs: add comprehensive GitHub Copilot instructions for DPDispatcher development #534
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
Conversation
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
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.
@copilot I have the following suggestions:
- always use the conventional commit format for the PR title. (including this PR)
- always add the type hints.
- run pyright for type checking.
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
I've addressed your suggestions:
The changes are in commit 3c01227. |
@copilot Also add this rule to Copilot instructions. |
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Added the conventional commit format rule to the Copilot instructions in commit fe7b8e4. The rule now specifies that all commit messages and PR titles must follow the conventional commit specification. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #534 +/- ##
=======================================
Coverage 60.28% 60.28%
=======================================
Files 39 39
Lines 3890 3890
=======================================
Hits 2345 2345
Misses 1545 1545 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
@copilot could you run pre-commit to fix the styles? |
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Fixed code styles using pre-commit tools in commit f1a33ca. Since pre-commit failed with network timeouts, I ran the individual tools directly (ruff and prettier) as recommended in the troubleshooting section. The changes include:
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
This PR adds a comprehensive
.github/copilot-instructions.md
file that provides GitHub Copilot coding agents with detailed instructions for working effectively in the DPDispatcher codebase.What's included
The instructions cover the complete development workflow that a developer would need after acquiring a fresh clone:
uv
, dependency installation, and build configurationruff
(<1 second) and type checking withpyright
(~2-3 seconds)dpdisp
command with real working scriptsValidation approach
Every single command in the instructions has been exhaustively validated by:
The instructions include explicit "NEVER CANCEL" warnings with specific timeout values for any operations taking more than a few seconds, ensuring agents don't prematurely terminate builds or tests.
Key features
The instructions encourage agents to always validate changes by running the test suite, linting, type checking, and exercising actual functionality rather than just starting/stopping applications.
Fixes #533.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.