Skip to content

Commit 899aec9

Browse files
tobioCopilot
andauthored
Apply suggestions from code review
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent cfef89b commit 899aec9

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
You will be writing or reviewing code for the Terraform provider for Elastic Stack (Elasticsearch, Kibana, Fleet, APM, and Logstash). This is a Go based repository hosting the provider source.
1+
You will be writing or reviewing code for the Terraform provider for Elastic Stack (Elasticsearch, Kibana, Fleet, APM, and Logstash). This is a Go-based repository hosting the provider source.
22

33
When writing code, you must adhere to the coding standards and conventions outlined in the [CODING_STANDARDS.md](../CODING_STANDARDS.md) document in this repository.
44

CODING_STANDARDS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This document outlines the coding standards and conventions used in the terrafor
1414
- Use the Plugin Framework for all new resources (not SDKv2)
1515
- Follow the code organization pattern of `internal/elasticsearch/security/system_user` for new Plugin Framework resources
1616
- Avoid adding extra functionality to the existing `utils` package. Instead:
17-
- Code should live as close the consumers.
17+
- Code should live as close to the consumers.
1818
- Resource, area, application specific shared logic should live at that level. For example within `internal/kibana` for Kibana specific shared logic.
1919
- Provider wide shared logic should be packaged together by a logical concept. For example `internal/diagutil` contains shared code for managing Terraform Diagnostics, and translating between errors, SDKv2 diags, and Plugin Framework diags.
2020

@@ -25,7 +25,7 @@ This document outlines the coding standards and conventions used in the terrafor
2525
- Use `customtypes.DurationType{}` for duration-based string attributes.
2626
- Use `customtypes.JSONWithDefaultsType{}` to allow users to specify only a subset of a JSON blob.
2727
- Always include comprehensive descriptions for all resources, and attributes.
28-
- Long, multiline descriptions should be stored in an external markdown file, which is imported via Golang embedding. See `resource-description.md` for examples.
28+
- Long, multiline descriptions should be stored in an external markdown file, which is imported via Golang embedding. See `internal/elasticsearch/security/system_user/resource-description.md` for an example location.
2929
- Use schema validation wherever possible. Only perform validation within create/read/update functions as a last resort.
3030
- For example, any validation that relies on the actual Elastic Stack components (e.g Elasticsearch version)
3131
can only be performed during the create/read/update phase.

0 commit comments

Comments
 (0)