Skip to content

Add pre-requisites in developer guide #55

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

Merged
joaopalet merged 1 commit into from
Feb 5, 2024
Merged

Add pre-requisites in developer guide #55

Show file tree
Hide file tree
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
13 changes: 9 additions & 4 deletions CONTRIBUTION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ Your contribution is welcome! Thank you for your interest in contributing to the

## Developer Guide

Prerequisites:

- [`Go`](https://go.dev/doc/install) 1.21+
- [`yamllint`](https://yamllint.readthedocs.io/en/stable/quickstart.html)

### 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.
Expand All @@ -23,9 +28,9 @@ Check the [Authentication](README.md#authentication) section on the README.
These commands can be executed from the project root:

- `make project-tools`: install the required dependencies
- `make build`: compiles the CLI and saves the binary under _./bin/stackit_
- `make lint`: lint the code and examples
- `make generate-docs`: generates Markdown documentation for every command
- `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
Expand Down Expand Up @@ -54,7 +59,7 @@ To test your changes, you can either:

To make your contribution, follow these steps:

1. Check open or recently closed [Pull Requests](https://github.com/stackitcloud/stackit-cli/pulls) and [Issues](https://github.com/stackitcloud/stackit-cli/issues)to make sure the contribution you are making has not been already tackled by someone else.
1. Check open or recently closed [Pull Requests](https://github.com/stackitcloud/stackit-cli/pulls) and [Issues](https://github.com/stackitcloud/stackit-cli/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
Expand Down
9 changes: 0 additions & 9 deletions scripts/project.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,8 @@ if [ "$action" = "help" ]; then
[ -f "$0".man ] && man "$0".man || echo "No help, please read the script in ${script}, we will add help later"
elif [ "$action" = "tools" ]; then
cd ${ROOT_DIR}

go mod download
go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.52.2

PIP_COMMAND="pip"
if ! command -v yamllint &>/dev/null; then
if command -v pip3 &>/dev/null; then
PIP_COMMAND="pip3"
fi
$PIP_COMMAND install yamllint
fi
else
echo "Invalid action: '$action', please use $0 help for help"
fi