stackit-dev-tools/terraform-provider-stackitprivatepreview
3
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

feat(docs): improve contribution docs (#1008)

Browse source 
relates to STACKITTPR-317
This commit is contained in:
Marcel Jacek 2025-09-25 17:34:02 +02:00 • committed by GitHub
parent 8aa4d29158
commit 4289012bda
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 66 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

13
CONTRIBUTION.md
View file

@ -93,12 +93,13 @@ https://github.com/stackitcloud/terraform-provider-stackit/blob/1b9225598a007cda
To test your changes locally, you have to compile the provider (requires Go 1.24) and configure the Terraform CLI to use the local version.
1. Clone the repository.
1. Run `$ make build` to build the Terraform provider binary in `<PATH_TO_REPO>/bin/`
1. Create a `.terraformrc` config file in your home directory (`~`) for the terraform CLI with the following content:
```hcl
provider_installation {
dev_overrides {
"registry.terraform.io/stackitcloud/stackit" = "<PATH_TO_BINARY>"
"registry.terraform.io/stackitcloud/stackit" = "<PATH_TO_REPO>/bin/"
}
# For all other providers, install them directly from their origin provider
@ -163,6 +164,16 @@ To make your contribution, follow these steps:
5. Create a pull request with your changes.
6. The pull request will be reviewed by the repo maintainers. If you need to make further changes, make additional commits to keep commit history. When the PR is merged, commits will be squashed.
> [!TIP]
>
> To ensure smooth review and integration of your code contributions, follow these guidelines:
>
> **Break down large changes into smaller PRs**: Separate new features or bigger changes into multiple smaller Pull Requests.
> This allows us to provide earlier feedback and makes it easier to review your PR.
>
> **Create a draft PR for early feedback**: If you want feedback during the implementation process, create a draft PR so we can have a look.
## Bug Reports
If you would like to report a bug, please open a [GitHub issue](https://github.com/stackitcloud/terraform-provider-stackit/issues/new).