Skip to content

Conversation

carchi8py
Copy link
Collaborator

No description provided.

@carchi8py carchi8py requested a review from Copilot April 25, 2025 21:58
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request adds a new code style guide for Terraform for ONTAP, detailing directory structures, naming conventions, and best practices for Resources, Data Sources, examples, documentation, and interfaces.

  • Introduces documentation for directory structure and resource examples.
  • Adds detailed guidelines for interface design and resource tests.
Files not reviewed (1)
  • .vscode/settings.json: Language not supported
Comments suppressed due to low confidence (2)

.github/copilot/code-style.md:2

  • [nitpick] Consider revising to 'Please adhere to these standards.' for improved grammar and clarity.
Please Adhere to these Standard.

.github/copilot/code-style.md:187

  • [nitpick] Ensure proper code formatting by closing the code tick; consider rephrasing to 'All Resources need the following 2 variables defined before the New<api>Resource() function. For example, for StorageVolume:'
- All Resources need the following 2 variables before the `New<api>Resource() function. Here is an example for StorageVolume

- The provider.go files is located at `/internal/provider/provider.go`

## Naming Rules
- Test live in the same directory as the file it testing. so `cluster_peer_resource.go` test is in the same directory with `cluster_peer_resource_test.go`
Copy link
Preview

Copilot AI Apr 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Rephrase for clarity and grammatical accuracy; for instance, 'Tests should reside in the same directory as the file they are testing, e.g. cluster_peer_resource_test.go alongside cluster_peer_resource.go.'

Suggested change
- Test live in the same directory as the file it testing. so `cluster_peer_resource.go` test is in the same directory with `cluster_peer_resource_test.go`
- Tests should reside in the same directory as the file they are testing. For example, the test for `cluster_peer_resource.go` should be located in the same directory and named `cluster_peer_resource_test.go`.

Copilot uses AI. Check for mistakes.

@carchi8py carchi8py requested a review from Copilot May 6, 2025 17:27
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces a new code style guidelines document for the Terraform for ONTAP provider. It outlines standards for directory structure, building instructions, naming rules, documentation requirements, resource tests, and interface code.

  • Added documentation for directory structure and file organization.
  • Provided detailed examples for resource creation, tests, and interface function implementations.
Files not reviewed (1)
  • .vscode/settings.json: Language not supported
Comments suppressed due to low confidence (2)

.github/copilot/code-style.md:2

  • [nitpick] Consider revising this line for grammatical consistency, for example: 'Please adhere to these standards.'
Please Adhere to these Standard.

.github/copilot/code-style.md:142

  • [nitpick] For clarity and consistency, consider changing 'New Resource' to 'New Resources' in this guideline.
New Resource need to import "github.com/netapp/terraform-provider-netapp-ontap/internal/provider/connection" to get the connection import

Aggregate resource
---
```
- here an an example of what a docs page should look like for the cifs share module
Copy link
Preview

Copilot AI May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Please correct the repeated 'an an' to 'an example', e.g., 'here is an example of what a docs page should look like for the CIFS share module'.

Suggested change
- here an an example of what a docs page should look like for the cifs share module
- here is an example of what a docs page should look like for the cifs share module

Copilot uses AI. Check for mistakes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant