Add comprehensive GitHub Copilot instructions for hexhamming development - #33
Merged
Merged
Conversation
Co-authored-by: mrecachinas <924243+mrecachinas@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] ✨ Set up Copilot instructions
Add comprehensive GitHub Copilot instructions for hexhamming development
Sep 6, 2025
mrecachinas
approved these changes
Sep 6, 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 GitHub Copilot coding agents with detailed instructions for working effectively in the hexhamming codebase.What's Included
The instructions cover all essential aspects of development in this repository:
Build and Setup
Testing and Validation
Code Quality Requirements
Repository Navigation
Validation
Every single command in the instructions has been tested and validated:
Key Features
Comprehensive Coverage: From initial setup through testing, code quality, and CI expectations
Reliability Focus: All commands tested in a clean environment with appropriate timeout warnings
Practical Guidance: Includes specific validation scenarios, common failure modes, and troubleshooting steps
Performance Awareness: Documents the high-performance nature of the codebase with vectorized algorithms and C++ extensions
This ensures that GitHub Copilot agents can work efficiently in the codebase without trial-and-error, reducing development friction and improving code quality.
Fixes #32.
💡 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.