mirror/QuickStack
1
0
Fork 0
mirror of https://github.com/biersoeckli/QuickStack.git synced 2026-02-11 05:59:23 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: added commit type "docs" and clarified chapter "Environment Setup"

Browse Source
This commit is contained in:
biersoeckli
2025-01-19 15:46:58 +01:00
parent ce52802788
commit cbb441adaa
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@@ -37,6 +37,7 @@ The `type` should be one of the following:
- `fix`: A bug fix.
- `style`: Changes that do not affect the meaning of the code (e.g. whitespace, formatting, etc.).
- `refactor`: Code changes that neither fix a bug nor add a feature.
- `docs`: Documentation changes.
- `test`: Adding or updating tests.
- `chore`: Changes to the build process or auxiliary tools.
@@ -76,7 +77,7 @@ yarn test
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.
Additionally to the devcontainer, you need a running k3s cluster.
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.
To connect to your own k3s test cluster, provide the kuberentes credentials in the file `k3s-config.yaml` in the root of the project.
#### Install Dependencies
```sh
@@ -89,4 +90,4 @@ yarn dev
```
### License
By contributing to QuickStack, you agree that your contributions will be licensed under the GPL-3.0 license.
By contributing to QuickStack, you agree that your contributions will be licensed under the GPL-3.0 license.