Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 3.24 KB

CONTRIBUTION.md

File metadata and controls

78 lines (50 loc) · 3.24 KB

Contribute to the STACKIT CLI

Your contribution is welcome! Thank you for your interest in contributing to the STACKIT CLI. We greatly value your feedback, feature requests, additions to the code, bug reports or documentation extensions.

Table of contents

Developer Guide

Prerequisites:

Repository structure

The CLI commands are located under internal/cmd, where each folder includes the source code for a group of commands. Inside pkg you can find several useful packages that are shared by the commands and provide additional functionality such as flags, globalflags, tables, etc.

Getting started

Check the Authentication section on the README.

Useful Make commands

These commands can be executed from the project root:

  • make project-tools: install the required dependencies
  • make build: compile the CLI and save the binary under ./bin/stackit
  • make lint: lint the code
  • make generate-docs: generate Markdown documentation for every command
  • make test: run unit tests

Local development

To test your changes, you can either:

  1. Build the application locally by running:

    $ go build -o ./bin/stackit

    To use the application from the root of the repository, you can run:

    $ ./bin/stackit [group] [subgroup] [command] [flags]

  2. Skip building and run the Go application directly using:

    $ go run . [group] [subgroup] [command] [flags]

Code Contributions

To make your contribution, follow these steps:

  1. Check open or recently closed Pull Requests and 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.

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.