Skip to content

Commit 567c2ce

Browse files
authored
Update CONTRIBUTING.md
1 parent 6a3f304 commit 567c2ce

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,35 @@
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 a issue first before you put a lot of work into it.
55

6-
Want to contribute, but dont 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.
7+
8+
1. Setup your development environment
9+
2. Fork the repository
10+
3. Create a new branch
11+
4. Make your changes
12+
5. Open a PR
713

814
## Development setup
15+
916
### Requirements
1017
- docker
18+
- kind
1119
- kubectl
1220
- kubero-cli
1321

14-
1522
### Start a cluster
16-
run a `kubero install` with the [CLI](https://github.com/kubero-dev/kubero-cli/releases/latest) and select kind. This will install a local cluster with a single node and all required components.
23+
Run `kubero install` with the [CLI](https://github.com/kubero-dev/kubero-cli/releases/latest) and select kind.
24+
This will install a local cluster with a single node and all required components.
1725

1826
### Export the kubeconfig
1927
```bash
2028
kind export kubeconfig --name kubero-XXX --kubeconfig ./kubeconfig
2129
```
2230

23-
### Create a namespace
31+
### Create a dev namespace
32+
This will avoid interference with the local kubero-ui instance.
2433
```bash
2534
kubectl create namespace kubero-dev
2635
```
@@ -32,23 +41,19 @@ mv .env.template .env
3241

3342
### Start local node server
3443
```bash
44+
cd server
3545
yarn install
3646
yarn dev
3747
```
3848

3949
```bash
4050
cd client
41-
npm install
42-
npm run dev
51+
yarn install
52+
yarn watch
4353
```
4454

55+
### start optional services
4556
If you need any additional services (Gitea, Github ...), just run `docker-compose up -d`, or add it to the `docker-compose.yml` file, if it is missing.
4657

4758
Nope. No extra database is required. All data is stored in the Kubernetes cluster.
4859

49-
## How to contribute your code
50-
51-
1. Fork the repository
52-
2. Create a new branch
53-
3. Make your changes
54-
4. Open a PR

0 commit comments

Comments
 (0)