Skip to content

chore: Add comprehensive GitHub Copilot development instructions #270

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.

Sign up for GitHub

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

Jump to bottom
Merged
shenxianpeng merged 4 commits into from
Sep 4, 2025
Merged

chore: Add comprehensive GitHub Copilot development instructions #270

shenxianpeng merged 4 commits into from
Sep 4, 2025

Conversation

Copy link
Contributor

Copilot AI commented Sep 4, 2025 •
edited
Loading

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with detailed instructions for working effectively in the commit-check codebase.

What's Included

The instructions cover all essential development workflows with validated commands and timing information:

Build & Test System

  • Build Process: nox -s build (~10 seconds, with network timeout handling)
  • Testing: Direct pytest execution (~1 second) vs nox sessions (5+ minutes when working)
  • Linting: Pre-commit integration with manual workarounds for network issues

Manual Validation Scenarios

Complete test scenarios for validating functionality after changes:

# Valid conventional commit
echo "fix: correct issue with validation" > test_commit.txt
python3 -m commit_check.main --message test_commit.txt

# Invalid commit format  
echo "invalid commit message" > test_commit_invalid.txt
python3 -m commit_check.main --message test_commit_invalid.txt
# Shows ASCII art rejection with detailed error messages

# Complex conventional commit with scope and body
echo "feat(api): add new user endpoint

This adds support for creating new users via the REST API." > test_complex_commit.txt
python3 -m commit_check.main --message test_complex_commit.txt

Tool Behavior Documentation

  • Conventional Commits: Supported types (feat, fix, docs, etc.), scope handling, breaking changes
  • Branch Naming: Enforced prefixes (feature/, bugfix/, etc.), special branch handling
  • Exit Codes: 0 for success, 1 for failures with colorized error output

Network Issues & Workarounds

Documented known PyPI timeout issues in CI environments with explicit workarounds:

  • Use PYTHONPATH=/home/runner/work/commit-check/commit-check for development
  • Direct pytest execution instead of nox sessions when network fails
  • Manual dependency installation with timeout flags

Development Guidance

Clear direction on when to use different approaches:

  • Quick Development: Direct Python module execution with PYTHONPATH
  • Production Builds: nox sessions (when network allows)
  • Isolated Testing: Direct pytest execution
  • Pre-commit Integration: pre-commit commands for hook validation

All commands have been thoroughly tested and validated in the development environment, with explicit timeout values and "NEVER CANCEL" warnings for long-running operations as requested.

Fixes #269.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • fonts.google.com
    • Triggering command: /usr/bin/python3 /home/REDACTED/.local/bin/sphinx-build -E -W -b html docs _build/html (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@shenxianpeng
Plan creation and initial repository exploration
08a9b54 
Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com>
@sonarqubecloud
Copy link

sonarqubecloud bot commented Sep 4, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@shenxianpeng
Create comprehensive .github/copilot-instructions.md with validated c…
2e57fad 
…ommands and timing

Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot development instructions Sep 4, 2025
Copilot AI requested a review from shenxianpeng September 4, 2025 01:12
@github-actions github-actions bot added documentation Improvements or additions to documentation labels Sep 4, 2025
@shenxianpeng shenxianpeng marked this pull request as ready for review September 4, 2025 01:15
@shenxianpeng shenxianpeng requested a review from a team as a code owner September 4, 2025 01:16
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 4, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Join our Discord community for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Sep 4, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@shenxianpeng shenxianpeng changed the title Add comprehensive GitHub Copilot development instructions docs: Add comprehensive GitHub Copilot development instructions Sep 4, 2025
@shenxianpeng shenxianpeng merged commit dc9dd4e into main Sep 4, 2025
8 checks passed
@shenxianpeng shenxianpeng deleted the copilot/fix-269 branch September 4, 2025 01:19
@shenxianpeng shenxianpeng added developer and removed documentation Improvements or additions to documentation labels Oct 10, 2025
@shenxianpeng shenxianpeng changed the title docs: Add comprehensive GitHub Copilot development instructions chore: Add comprehensive GitHub Copilot development instructions Oct 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@shenxianpeng shenxianpeng shenxianpeng approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@shenxianpeng shenxianpeng

Copilot code review Copilot

Labels

developer

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

2 participants

@shenxianpeng