Skip to content

Commit 26895e2

Browse files
authored
Add pre-requisites in developer guide (#55)
1 parent 39277dc commit 26895e2

File tree

2 files changed

+9
-13
lines changed

2 files changed

+9
-13
lines changed

CONTRIBUTION.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ Your contribution is welcome! Thank you for your interest in contributing to the
1010

1111
## Developer Guide
1212

13+
Prerequisites:
14+
15+
- [`Go`](https://go.dev/doc/install) 1.21+
16+
- [`yamllint`](https://yamllint.readthedocs.io/en/stable/quickstart.html)
17+
1318
### Repository structure
1419

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

2530
- `make project-tools`: install the required dependencies
26-
- `make build`: compiles the CLI and saves the binary under _./bin/stackit_
27-
- `make lint`: lint the code and examples
28-
- `make generate-docs`: generates Markdown documentation for every command
31+
- `make build`: compile the CLI and save the binary under _./bin/stackit_
32+
- `make lint`: lint the code
33+
- `make generate-docs`: generate Markdown documentation for every command
2934
- `make test`: run unit tests
3035

3136
#### Local development
@@ -54,7 +59,7 @@ To test your changes, you can either:
5459

5560
To make your contribution, follow these steps:
5661

57-
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.
62+
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.
5863
2. Fork the repo.
5964
3. Make your changes in a branch that is up-to-date with the original repo's `main` branch.
6065
4. Commit your changes including a descriptive message

scripts/project.sh

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,8 @@ if [ "$action" = "help" ]; then
1313
[ -f "$0".man ] && man "$0".man || echo "No help, please read the script in ${script}, we will add help later"
1414
elif [ "$action" = "tools" ]; then
1515
cd ${ROOT_DIR}
16-
1716
go mod download
1817
go install github.com/golangci/golangci-lint/cmd/[email protected]
19-
20-
PIP_COMMAND="pip"
21-
if ! command -v yamllint &>/dev/null; then
22-
if command -v pip3 &>/dev/null; then
23-
PIP_COMMAND="pip3"
24-
fi
25-
$PIP_COMMAND install yamllint
26-
fi
2718
else
2819
echo "Invalid action: '$action', please use $0 help for help"
2920
fi

0 commit comments

Comments
 (0)