docs: add comprehensive GitHub Copilot instructions for cpp-linter-hooks development#116
docs: add comprehensive GitHub Copilot instructions for cpp-linter-hooks development#116
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #116 +/- ##
=======================================
Coverage 94.44% 94.44%
=======================================
Files 3 3
Lines 108 108
=======================================
Hits 102 102
Misses 6 6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@copilot I have told you that the pr title should follow the conventional commits |
Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com>
|
Updated the commit message to follow conventional commits format: "docs: add comprehensive GitHub Copilot instructions" (commit a1e65b6) |
|
2bdffbb to
a076581
Compare



This PR adds a comprehensive
.github/copilot-instructions.mdfile that provides GitHub Copilot coding agents with detailed instructions for working effectively in the cpp-linter-hooks codebase.Key Features
Exhaustively Validated Commands: Every command in the instructions has been tested and verified to work correctly, including:
pip install .[dev])Critical Timing Information: Documents exact execution times with appropriate safety margins:
Network Limitation Workarounds: Addresses known pre-commit setup issues in CI environments by providing local system hook configurations that bypass network timeouts.
Complete Validation Scenarios: Includes step-by-step workflows for testing changes:
Repository Navigation Guide: Documents key files, directory structure, and common development workflows specific to this Python package that provides pre-commit hooks for C/C++ linting.
The instructions follow an imperative tone throughout ("Run this command", "Do not do that") and include explicit "NEVER CANCEL" warnings for all long-running operations to prevent premature timeout cancellations.
The PR title and commit message follow conventional commits format as requested.
Fixes #110.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.