Setup Copilot instructions for cbElasticsearch repository #145
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 comprehensive GitHub Copilot instructions to help AI coding assistants work effectively with the cbElasticsearch module. The instructions provide essential context about the project's architecture, coding conventions, and development practices.
What's Added
A new
.github/copilot-instructions.mdfile that includes:.cfformat.jsonand.cflintrcconfigurationsWhy This Matters
The cbElasticsearch module uses ColdFusion/CFML with the ColdBox framework, which has specific patterns and conventions that may not be familiar to all AI coding assistants. These instructions ensure that:
Example Impact
Before these instructions, an AI assistant might write generic code. With these instructions, it will understand to write ColdBox-specific patterns like:
component accessors="true" { property name="config" inject="Config@cbelasticsearch"; public SearchBuilder function match( required string field, required any value ) { // Fluent API pattern that returns this for chaining return this; } }This follows the project's established patterns for dependency injection, fluent APIs, and CFML conventions.
Fixes #144.
💡 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.