You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff 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 Gobased 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.
2
2
3
3
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.
Copy file name to clipboardExpand all lines: CODING_STANDARDS.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ This document outlines the coding standards and conventions used in the terrafor
14
14
- Use the Plugin Framework for all new resources (not SDKv2)
15
15
- Follow the code organization pattern of `internal/elasticsearch/security/system_user` for new Plugin Framework resources
16
16
- 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.
18
18
- Resource, area, application specific shared logic should live at that level. For example within `internal/kibana` for Kibana specific shared logic.
19
19
- 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.
20
20
@@ -25,7 +25,7 @@ This document outlines the coding standards and conventions used in the terrafor
25
25
- Use `customtypes.DurationType{}` for duration-based string attributes.
26
26
- Use `customtypes.JSONWithDefaultsType{}` to allow users to specify only a subset of a JSON blob.
27
27
- 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.
29
29
- Use schema validation wherever possible. Only perform validation within create/read/update functions as a last resort.
30
30
- For example, any validation that relies on the actual Elastic Stack components (e.g Elasticsearch version)
31
31
can only be performed during the create/read/update phase.
0 commit comments