Add comprehensive GitHub Copilot instructions for cpp-linter-hooks development#111
Closed
Add comprehensive GitHub Copilot instructions for cpp-linter-hooks development#111
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #111 +/- ##
=======================================
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:
|
…ands 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 instructions for cpp-linter-hooks development
Sep 14, 2025
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



This PR adds a comprehensive
.github/copilot-instructions.mdfile that provides detailed guidance for GitHub Copilot coding agents working with the cpp-linter-hooks repository.What's Included
The instructions cover all essential development workflows with validated commands and precise timing information:
🚀 Setup & Build Process
pip install .[dev]~10s, clang tools ~2s)ruff check .,ruff format --check .)🧪 Testing & Validation
🛠 Hook Functionality
clang-format-hookandclang-tidy-hookcommands📋 Comprehensive Reference
cpp_linter_hooks/,tests/,testing/)Validation
Every command, timing estimate, and workflow described in the instructions has been thoroughly tested and validated to ensure reliability. The instructions follow the imperative tone requirement and include explicit "NEVER CANCEL" warnings for long-running operations.
This provides coding agents with complete, accurate guidance to work effectively with the codebase from a fresh clone, eliminating the need for extensive exploration or trial-and-error approaches.
Fixes #110.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.