Fix GitHub Copilot custom instructions file structure for catalog markdown files #809
Conversation
Co-authored-by: HerringtonDarkholme <[email protected]>
Copilot
AI
changed the title
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Join our Discord community for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Please follow the guide in
https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/configure-custom-instructions/add-repository-instructions#creating-a-repository-custom-instructions-file
Using one or more .instructions.md files
Create the .github/instructions directory if it does not already exist.
Create one or more .instructions.md files, adding natural language instructions to the file(s).
Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility.
Specify what files or directories the instructions apply to by adding applyTo frontmatter to the Markdown files, using glob syntax.
applyTo: "app/models/**/*.rb"
Add custom instructions here
To apply the instructions to all files, use the ** pattern.
- Create .github/instructions/ directory as per GitHub documentation - Move content to catalog.instructions.md with proper frontmatter - Add applyTo frontmatter with glob pattern for website/catalog/**/*.md - Remove incorrectly placed catalog.instruction.md file Follows the guidelines from: https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/configure-custom-instructions/add-repository-instructions Co-authored-by: HerringtonDarkholme <[email protected]>
Fixed! I've restructured the custom instructions file to follow the GitHub guidelines:
The structure now follows the official documentation you linked. Commit: 26f8b4d |
Copilot
AI
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR establishes proper GitHub Copilot custom instructions to assist with creating and managing ast-grep rule examples in the catalog. The change implements the correct GitHub directory structure and filename convention while providing comprehensive workflow guidance for catalog contributors.
Key Changes:
- Creates GitHub Copilot custom instructions following official format requirements
- Provides structured 7-step workflow for catalog rule creation
- Establishes quality standards and formatting conventions for rule examples
This PR adds proper GitHub Copilot custom instructions for working with catalog markdown files in the
website/catalog/directory, following the official GitHub documentation structure.What's Fixed
The custom instructions file now follows the correct GitHub format:
.github/instructions/directory as required by GitHub.instructions.mdnaming convention instead of.instruction.mdapplyTofrontmatter with glob pattern targetingwebsite/catalog/**/*.mdInstructions Provided
The
catalog.instructions.mdfile provides comprehensive guidance for creating and managing ast-grep rule examples:Complete Workflow (7 steps):
rule-template.mdas a foundationindex.mdKey Features:
Benefits
GitHub Copilot will now provide contextual assistance specific to catalog development workflows, helping contributors create consistent, high-quality catalog entries that follow established conventions.
Fixes #808.
💡 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.