From beaa94586539c4787b525416776246f33aca107b Mon Sep 17 00:00:00 2001 From: vicentepinto98 Date: Wed, 13 Sep 2023 16:49:04 +0100 Subject: [PATCH 1/4] Update contribution.md --- CONTRIBUTION.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 48 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index 08d971c5..4c49c305 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -1,6 +1,51 @@ ## Contribute -Your contribution is welcome! Please create a pull request (PR). The STACKIT Developer Tools team will review it. -The SDK service modules are automatically generated from the [REST API specs](https://github.com/stackitcloud/stackit-api-specifications). Therefore, changes to these modules will not be accepted. Instead, consider proposing changes to the generation process in the [Generator repository](https://github.com/stackitcloud/stackit-sdk-generator) -A more detailed contribution guideline is planned to come. \ No newline at end of file +The SDK service modules are + + +# Contribute to the STACKIT Go SDK +Your contribution is welcome! Thank you for your interest in contributing to the STACKIT Go SDK. We greatly value your feedback, feature requests, additions to the code, bug reports or documentation extensions. + +## Table of contents +- [Developer Guide](#developer-guide) +- [Code Contributions](#code-contributions) +- [Bug Reports](#bug-reports) + +## Developer Guide +### Repository structure +The SDK STACKIT service modules are located under `services`, which are automatically generated from the [REST API specs](https://github.com/stackitcloud/stackit-api-specifications), except from the `wait.go` and `wait_test.go` files. Therefore, changes to these modules will not be accepted. Instead, consider proposing changes to the generation process in the [Generator repository](https://github.com/stackitcloud/stackit-sdk-generator). + +Inside `core` you can find several packages that are used by all service modules, such as `auth`, `config` and `wait`. Examples of usage of the SDK are located under the `examples` folder. + +### Getting started + +Check the [Getting Started](README.md#getting-started) and [Authentication](README.md#authentication) sections on the README. + +#### Useful Make commands + +These commands can be executed from the project root: + +- `make project-tools`: get the required dependencies +- `make lint`: lint the code and the examples and sync dependencies +- `make test`: run unit tests + +## Code Contributions + +To make your contribution, follow these steps: +1. Check open or recently closed [Pull Requests](https://github.com/stackitcloud/stackit-sdk-go/pulls) and [Issues](https://github.com/stackitcloud/stackit-sdk-go/issues)to make sure the contribution you are making has not been already tackled by someone else. +2. Fork the repo. +3. Make your changes in a branch that is up-to-date with the original repo's `main` branch. +4. Commit your changes including a descriptive message. +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. + +## Bug Reports +If you would like to report a bug, please open a [GitHub issue](https://github.com/stackitcloud/stackit-sdk-go/issues/new). + +To ensure we can provide the best support to your issue, follow these guidelines: + +1. Go through the existing issues to check if your issue has already been reported. +2. Make sure you are using the latest version of the provider, we will not provide bug fixes for older versions. Also, latest versions may have the fix for your bug. +3. Please provide as much information as you can about your environment, e.g. your version of Go, your version of the provider, which operating system you are using and the corresponding version. +4. Include in your issue the steps to reproduce it, along with code snippets and/or information about your specific use case. This will make the support process much easier and efficient. From b7dffdf1e93be1b995605260b47302be2877ecbb Mon Sep 17 00:00:00 2001 From: vicentepinto98 Date: Wed, 13 Sep 2023 16:49:12 +0100 Subject: [PATCH 2/4] Update contribution.md --- CONTRIBUTION.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index 4c49c305..85008b9f 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -1,9 +1,3 @@ -## Contribute - - -The SDK service modules are - - # Contribute to the STACKIT Go SDK Your contribution is welcome! Thank you for your interest in contributing to the STACKIT Go SDK. We greatly value your feedback, feature requests, additions to the code, bug reports or documentation extensions. From f7910e1a023d084ff63cf242fe8738278fdc48a0 Mon Sep 17 00:00:00 2001 From: vicentepinto98 Date: Wed, 13 Sep 2023 16:51:46 +0100 Subject: [PATCH 3/4] Update sentence --- CONTRIBUTION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index 85008b9f..3910d0aa 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -8,7 +8,7 @@ Your contribution is welcome! Thank you for your interest in contributing to the ## Developer Guide ### Repository structure -The SDK STACKIT service modules are located under `services`, which are automatically generated from the [REST API specs](https://github.com/stackitcloud/stackit-api-specifications), except from the `wait.go` and `wait_test.go` files. Therefore, changes to these modules will not be accepted. Instead, consider proposing changes to the generation process in the [Generator repository](https://github.com/stackitcloud/stackit-sdk-generator). +The SDK STACKIT service modules are located under `services`, which are automatically generated from the [REST API specs](https://github.com/stackitcloud/stackit-api-specifications), except from the `wait.go` and `wait_test.go` files. Therefore, changes to these modules besides the `wait.go` and `wait_test.go` files will not be accepted. Instead, consider proposing changes to the generation process in the [Generator repository](https://github.com/stackitcloud/stackit-sdk-generator). Inside `core` you can find several packages that are used by all service modules, such as `auth`, `config` and `wait`. Examples of usage of the SDK are located under the `examples` folder. From 2d7bce3ed69f7e61e648e771b1a9f5b880b96e4f Mon Sep 17 00:00:00 2001 From: Vicente Pinto Date: Thu, 14 Sep 2023 10:58:33 +0100 Subject: [PATCH 4/4] Update CONTRIBUTION.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: João Palet --- CONTRIBUTION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index 3910d0aa..6cca7b6e 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -8,7 +8,7 @@ Your contribution is welcome! Thank you for your interest in contributing to the ## Developer Guide ### Repository structure -The SDK STACKIT service modules are located under `services`, which are automatically generated from the [REST API specs](https://github.com/stackitcloud/stackit-api-specifications), except from the `wait.go` and `wait_test.go` files. Therefore, changes to these modules besides the `wait.go` and `wait_test.go` files will not be accepted. Instead, consider proposing changes to the generation process in the [Generator repository](https://github.com/stackitcloud/stackit-sdk-generator). +The SDK STACKIT service modules are located under `services`, which are automatically generated from the [REST API specs](https://github.com/stackitcloud/stackit-api-specifications), except for the `wait.go` and `wait_test.go` files. Therefore, changes to these modules besides the `wait.go` and `wait_test.go` files will not be accepted. Instead, consider proposing changes to the generation process in the [Generator repository](https://github.com/stackitcloud/stackit-sdk-generator). Inside `core` you can find several packages that are used by all service modules, such as `auth`, `config` and `wait`. Examples of usage of the SDK are located under the `examples` folder.