Skip to content

docs: remove duplicated word and fix missing preposition in CONTRIBUTING.md #1610

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.

Sign up for GitHub

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
amir-rezaei wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: remove duplicated word and fix missing preposition in CONTRIBUTING.md #1610

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ We make use of the [Terraform Plugin Framework](https://developer.hashicorp.com/

### Implementing a new resource

Let's suppose you want to want to implement a new resource `bar` of service `foo`:
Let's suppose you want to implement a new resource `bar` of service `foo`:

1. You would start by creating a new folder `bar/` inside `stackit/internal/services/foo/`
2. Following with the creation of a file `resource.go` inside your new folder `stackit/internal/services/foo/bar/`
Expand All @@ -54,7 +54,7 @@ Let's suppose you want to want to implement a new resource `bar` of service `foo
}
```

Please remember to always add unit tests for the helper functions (in this case `mapFields` and `toCreatePayload`), as well implementing/extending the acceptance (end-to-end) tests. Our acceptance tests are implemented using Hashicorp's [terraform-plugin-testing](https://developer.hashicorp.com/terraform/plugin/testing/acceptance-tests) package.
Please remember to always add unit tests for the helper functions (in this case `mapFields` and `toCreatePayload`), as well as implementing/extending the acceptance (end-to-end) tests. Our acceptance tests are implemented using Hashicorp's [terraform-plugin-testing](https://developer.hashicorp.com/terraform/plugin/testing/acceptance-tests) package.

Additionally, remember to run `make generate-docs` after your changes to keep the commands' documentation in `docs/` updated, which is used as a source for the [Terraform Registry documentation page](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs).

Expand Down