-
Notifications
You must be signed in to change notification settings - Fork 113
Add copilot instructions and issue template tweaks #1205
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
wandergeek
wants to merge
6
commits into
elastic:main
Choose a base branch
from
wandergeek:copilot-instructions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
d09b456
Add copilot instructions and issue template tweaks
wandergeek 18a33b5
Update .github/copilot-instructions.md
wandergeek 044a487
Update .github/copilot-instructions.md
wandergeek 14a9954
Update .github/copilot-instructions.md
wandergeek 28bd8dd
remove dumb file counts
wandergeek 70d8a20
Build out prompt further
wandergeek File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
This is a Go based repository hosting a Terrform provider for the elastic stack (elasticsearch and kibana) APIs. This repo currently supports both [plugin framework](https://developer.hashicorp.com/terraform/plugin/framework/getting-started/code-walkthrough) and [sdkv2](https://developer.hashicorp.com/terraform/plugin/sdkv2) resources. All new resources _must_ use the plugin framework. | ||
|
||
For further information, please see [README.md](../README.md) and the [CONTRIBUTING.md](../CONTRIBUTING.md) docs. | ||
|
||
## Code Standards | ||
|
||
### Required Before Each Commit | ||
- Run `make fmt` before committing any changes to ensure proper code formatting, this will run gofmt on all Go files to maintain consistent style. | ||
- Run `make lint` to ensure any linting errors have not surfaced with your changes | ||
|
||
### Required Before Pull Request | ||
- Run `make gen` to update the documentation and code based on your changes. | ||
wandergeek marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Development Flow | ||
- Develop feature or fix bug | ||
- Write tests to validate behavior | ||
- Run `make test` to run test suite | ||
|
||
## Repository Structure | ||
|
||
• **docs/** - Documentation files | ||
• **data-sources/** - Documentation for Terraform data sources (51 files) | ||
wandergeek marked this conversation as resolved.
Show resolved
Hide resolved
|
||
• **guides/** - User guides and tutorials | ||
• **resources/** - Documentation for Terraform resources (35 files) | ||
• **examples/** - Example Terraform configurations | ||
• **cloud/** - Examples using the cloud to launch testing stacks | ||
• **data-sources/** - Data source usage examples (45+ examples) | ||
• **resources/** - Resource usage examples (30+ examples) | ||
• **provider/** - Provider configuration examples | ||
• **generated/** - Auto-generated clients from the `generate-clients` make target | ||
• **alerting/** - Kibana alerting API client | ||
• **connectors/** - Kibana connectors API client | ||
• **kbapi/** - Kibana API client | ||
• **slo/** - SLO (Service Level Objective) API client | ||
• **internal/** - Internal Go packages | ||
• **acctest/** - Acceptance test utilities | ||
• **clients/** - API client implementations | ||
• **elasticsearch/** - Elasticsearch-specific logic | ||
• **fleet/** - Fleet management functionality | ||
• **kibana/** - Kibana-specific logic | ||
• **models/** - Data models and structures | ||
• **schema/** - Connection schema definitions for plugin framework | ||
• **utils/** - Utility functions | ||
• **versionutils/** - Version handling utilities | ||
• **libs/** - External libraries | ||
• **go-kibana-rest/** - Kibana REST API client library | ||
• **provider/** - Core Terraform provider implementation | ||
• **scripts/** - Utility scripts for development and CI | ||
• **templates/** - Template files for documentation generation | ||
• **data-sources/** - Data source documentation templates | ||
• **resources/** - Resource documentation templates | ||
• **guides/** - Guide documentation templates | ||
• **xpprovider/** - Additional provider functionality needed for Crossplane | ||
|
||
## Key Guidelines | ||
* Follow Go best practices and idiomatic patterns | ||
* Maintain existing code structure and organization | ||
* Write unit tests for new functionality. Use table-driven unit tests when possible. | ||
wandergeek marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* Avoid adding any extra functionality into the `utils` package, instead preferencing adding to a more specific package or creating one to match the purpose | ||
* Think through your planning first using the codebase as your guide before creating new resources and data sources | ||
|
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.