Skip to content

Commit 26fb37b

Browse files
authored
Update CONTRIBUTING.md
1 parent 567c2ce commit 26fb37b

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,46 @@
11
# How to contribute
22

33
All contributions are welcome. For simple typos, just open a PR.
4-
For bigger ideas it might be better to open a issue first before you put a lot of work into it.
4+
For bigger ideas it might be better to open an issue first before you put a lot of work into it.
55

6-
Want to contribute, but don't know where to start? Have a look into the Roadmap.
6+
Want to contribute, but don't know where to start? Have a look into the [Roadmap](https://github.com/orgs/kubero-dev/projects/1).
77

88
1. Setup your development environment
99
2. Fork the repository
1010
3. Create a new branch
1111
4. Make your changes
1212
5. Open a PR
1313

14-
## Development setup
14+
## Development setup for the Kubero UI
1515

1616
### Requirements
1717
- docker
1818
- kind
1919
- kubectl
2020
- kubero-cli
21+
- git
2122

22-
### Start a cluster
23-
Run `kubero install` with the [CLI](https://github.com/kubero-dev/kubero-cli/releases/latest) and select kind.
23+
### 1) prepare your local code
24+
Fork the repository https://github.com/kubero-dev/kubero into your account.
25+
26+
### 2) Start a cluster
27+
Run `kubero install` with the [CLI](https://github.com/kubero-dev/kubero-cli/releases/latest) and select `kind`.
2428
This will install a local cluster with a single node and all required components.
2529

26-
### Export the kubeconfig
30+
You can skip the kubero-UI step since we will use our local code.
31+
32+
### 3) Export the kubeconfig
2733
```bash
2834
kind export kubeconfig --name kubero-XXX --kubeconfig ./kubeconfig
2935
```
3036

3137
### Create a dev namespace
32-
This will avoid interference with the local kubero-ui instance.
38+
This step is optional but will avoid interference with the local InCluster kubero-ui instance.
3339
```bash
3440
kubectl create namespace kubero-dev
3541
```
3642

37-
### configure Kubero's environment
43+
### Configure Kubero's environment
3844
```bash
3945
mv .env.template .env
4046
```

0 commit comments

Comments
 (0)