Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 24, 2025

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:

  • Bootstrap and setup: Virtual environment creation with uv, dependency installation, and build configuration
  • Testing workflow: Complete test suite execution with coverage reporting (~25 seconds)
  • Code quality: Linting and formatting with ruff (<1 second) and type checking with pyright (~2-3 seconds)
  • Documentation: Sphinx documentation building (~14 seconds)
  • CLI usage: Examples of using the dpdisp command with real working scripts
  • Project structure: Key components, directories, and configuration files
  • Validation scenarios: Specific user workflows to test after making changes
  • Development guidelines: Including conventional commit format requirements and type hints

Validation approach

Every single command in the instructions has been exhaustively validated by:

  1. Testing from multiple fresh repository clones
  2. Measuring actual execution times for timeout recommendations
  3. Running complete end-to-end scenarios including CLI usage
  4. Verifying all example scripts produce expected output

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

  • Imperative tone: Clear "Run [this command]" style instructions
  • Timing guarantees: All commands include measured execution times
  • Real examples: Working code examples that actually execute successfully
  • Troubleshooting: Common issues and solutions for development setup
  • Complete coverage: From initial setup through testing, building, type checking, and deployment
  • Best practices: Conventional commit format and type annotations guidelines

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.

Copilot AI and others added 2 commits August 24, 2025 08:15
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for DPDispatcher development Aug 24, 2025
@Copilot Copilot AI requested a review from njzjz August 24, 2025 08:22
Copilot finished work on behalf of njzjz August 24, 2025 08:22
Copy link
Member

@njzjz njzjz left a 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>
Copy link
Contributor Author

Copilot AI commented Aug 24, 2025

@copilot I have the following suggestions:

  • always use the conventional commit format for the PR title. (including this PR)
  • always add the type hints....

I've addressed your suggestions:

  1. PR title: I cannot directly update the PR title, but this should be "docs: add comprehensive GitHub Copilot instructions for DPDispatcher development" to follow conventional commit format.

  2. Type hints: Added guideline to always add type hints in the development notes section.

  3. Pyright: Added pyright type checking instructions to the copilot instructions, including timing information and integration into the validation workflow.

The changes are in commit 3c01227.

@Copilot Copilot AI changed the title Add comprehensive GitHub Copilot instructions for DPDispatcher development docs: add comprehensive GitHub Copilot instructions for DPDispatcher development Aug 24, 2025
@Copilot Copilot AI requested a review from njzjz August 24, 2025 08:50
Copilot finished work on behalf of njzjz August 24, 2025 08:50
@njzjz
Copy link
Member

njzjz commented Aug 24, 2025

PR title: I cannot directly update the PR title, but this should be "docs: add comprehensive GitHub Copilot instructions for DPDispatcher development" to follow conventional commit format.

@copilot Also add this rule to Copilot instructions.

Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Aug 24, 2025

PR title: I cannot directly update the PR title, but this should be "docs: add comprehensive GitHub Copilot instructions for DPDispatcher development" to follow conventional commit format.

@copilot...

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.

Copilot finished work on behalf of njzjz August 24, 2025 08:57
Copy link

codecov bot commented Aug 24, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 60.28%. Comparing base (6c48f43) to head (8198a40).
⚠️ Report is 1 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@njzjz
Copy link
Member

njzjz commented Aug 24, 2025

@copilot could you run pre-commit to fix the styles?

Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Aug 24, 2025

@copilot could you run pre-commit to fix the styles?

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:

  • Improved markdown formatting with prettier (better spacing around code blocks and headers)
  • Added node_modules/ to .gitignore
  • All Python code was already properly formatted (no ruff changes needed)

Copilot finished work on behalf of njzjz August 24, 2025 09:11
@njzjz
Copy link
Member

njzjz commented Aug 24, 2025

pre-commit.ci autofix

@njzjz njzjz marked this pull request as ready for review August 24, 2025 09:26
@njzjz njzjz merged commit 43d6e67 into master Aug 24, 2025
55 checks passed
@njzjz njzjz deleted the copilot/fix-533 branch August 24, 2025 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions
2 participants