add contributing

Author: mms-gianni

.env.template

@@ -3,7 +3,7 @@ PORT=2000
 KUBERO_WEBHOOK_SECRET=mysecret
 
 # Github webhook configuration
-KUBERO_WEBHOOK_URL=https://
+KUBERO_WEBHOOK_URL=https://kuberoXXXXXXXXXXXXX.loca.lt/api/repo/webhooks
 GITHUB_PERSONAL_ACCESS_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
 #GITEA_PERSONAL_ACCESS_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
@@ -12,7 +12,7 @@ GITHUB_PERSONAL_ACCESS_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 KUBECONFIG_PATH=./kubeconfig
 KUBERO_CONFIG_PATH=./config.yaml
 KUBERO_CONTEXT=kind-kubero
-KUBERO_NAMESPACE=kubero
+KUBERO_NAMESPACE=kubero-dev
 KUBERO_SESSION_KEY=randomString
 
 #GITHUB_CLIENT_SECRET=

CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# How to contribute
+
+All contributions are welcome. For simple typos, just open a PR.
+For bigger ideas it might be better to open a issue first before you put a lot of work into it. This way we can discuss the idea first.
+
+## Development setup
+### Requirements
+- docker
+- kubectl
+- kubero-cli
+
+
+### Start a cluster
+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.
+
+### Export the kubeconfig
+```bash
+kind export kubeconfig --name kubero-XXX --kubeconfig ./kubeconfig
+```
+
+### Create a namespace
+```bash
+kubectl create namespace kubero-dev
+```
+
+### configure Kubero's environment
+```bash
+mv .env.template .env
+```
+
+### Start local node server
+```bash
+yarn install
+yarn dev
+```
+
+```bash
+cd client
+npm install
+npm run dev
+```
+
+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.
+
+Nope. No extra database is required. All data is stored in the Kubernetes cluster.
+
+## How to contribute your code
+
+1. Fork the repository
+2. Create a new branch
+3. Make your changes
+4. Open a PR