Skip to content

Commit

Permalink
Add contribution section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
ridoo committed Aug 9, 2023
1 parent 3136139 commit 1e30a93
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

# Helm Chart for Geonode

Table of Contents
=================
- [GeoWhat?](#Geonode)
- [Geonode-k8s](#geonode-k8s)
- [Install Guilde](#install)
Expand Down Expand Up @@ -82,3 +80,23 @@ helm upgrade --cleanup-on-fail --install --namespace geonode --create-namespac
```bash
helm delete --namespace geonode geonode deployment/geonode
```

## Contribution

### Create an Issue

You found a bug :lady_beetle:?
You have an idea how to improve :bulb:?
Feel free to [create an issue](https://github.com/zalf-rdm/geonode-k8s/issues/new/choose)!


### Documentation

Ensure values.yaml documentation is up-to-date.
The [parameter documentation](main/deployment/geonode/README.md) is generated via [`helm-docs`](https://github.com/norwoodj/helm-docs).
There is a pre-commit hook configuration so please ensure you install it into your local working copy via

```
pre-commit install
pre-commit install-hooks
```

0 comments on commit 1e30a93

Please sign in to comment.