Skip to content

Commit

Permalink
Update CONTRIBUTION.md (#8)
Browse files Browse the repository at this point in the history
* Update contribution.md

* Update contribution.md

* Update sentence

* Update CONTRIBUTION.md

Co-authored-by: João Palet <[email protected]>

---------

Co-authored-by: João Palet <[email protected]>
  • Loading branch information
vicentepinto98 and joaopalet authored Sep 14, 2023
1 parent ecc0122 commit 55a23a9
Showing 1 changed file with 43 additions and 4 deletions.
47 changes: 43 additions & 4 deletions CONTRIBUTION.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,45 @@
## Contribute
Your contribution is welcome! Please create a pull request (PR). The STACKIT Developer Tools team will review it.
# 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.

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)
## Table of contents
- [Developer Guide](#developer-guide)
- [Code Contributions](#code-contributions)
- [Bug Reports](#bug-reports)

A more detailed contribution guideline is planned to come.
## 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 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.

### 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.

0 comments on commit 55a23a9

Please sign in to comment.