Skip to content

Commit cbb441a

Browse files
committed
docs: added commit type "docs" and clarified chapter "Environment Setup"
1 parent ce52802 commit cbb441a

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ The `type` should be one of the following:
3737
- `fix`: A bug fix.
3838
- `style`: Changes that do not affect the meaning of the code (e.g. whitespace, formatting, etc.).
3939
- `refactor`: Code changes that neither fix a bug nor add a feature.
40+
- `docs`: Documentation changes.
4041
- `test`: Adding or updating tests.
4142
- `chore`: Changes to the build process or auxiliary tools.
4243

@@ -76,7 +77,7 @@ yarn test
7677
To setup a developement environment, use the provided devcontainer configuration. This will setup a development environment with all necessary dependencies and the correct node version.
7778

7879
Additionally to the devcontainer, you need a running k3s cluster.
79-
To connect to your own k3s test cluster, provide the kuberentes credentials in the file `k3s-config.yaml` in the root of the project with the following content.
80+
To connect to your own k3s test cluster, provide the kuberentes credentials in the file `k3s-config.yaml` in the root of the project.
8081

8182
#### Install Dependencies
8283
```sh
@@ -89,4 +90,4 @@ yarn dev
8990
```
9091

9192
### License
92-
By contributing to QuickStack, you agree that your contributions will be licensed under the GPL-3.0 license.
93+
By contributing to QuickStack, you agree that your contributions will be licensed under the GPL-3.0 license.

0 commit comments

Comments
 (0)