Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
asbiin committed Oct 27, 2024
1 parent 1d10fc6 commit 0b4c71b
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 2 deletions.
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing

## Testing

Install prerequisites:
- [helm](https://helm.sh/)
- [helm chart testing](https://github.com/helm/chart-testing)
- [minikube](https://minikube.sigs.k8s.io/docs/start/)

Start minikube:

```sh
minikube start
```

Start chart-testing:

```sh
ct install --config ct.yaml --helm-extra-args '--timeout 200s'
```

You can also add a yaml file in the `charts/monica/ci` directory to test the chart with different values.

## Pre-commit

This repository uses [pre-commit](https://pre-commit.com/) to run checks before each commit.

To install pre-commit, run:

```sh
pre-commit install
```
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[Helm](https://helm.sh) repo for different charts related to Monica which can be installed on [Kubernetes](https://kubernetes.io)

### Add Helm repository
## Add Helm repository

To install the repo just run:

Expand All @@ -11,7 +11,7 @@ helm repo add monica https://monicahq.github.io/helm/
helm repo update
```

### Helm Charts
## Helm Charts

* [monica](https://monicahq.github.io/helm/)

Expand All @@ -24,3 +24,18 @@ helm repo update
```

For more information, please checkout the chart level [README.md](./charts/monica/README.md).


## Contributing

Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.

## License

Author: [Alexis Saettler](https://github.com/asbiin)

This project is part of [MonicaHQ](https://github.com/monicahq/).

Copyright © 2019–2024.

Licensed under the AGPL-3.0 License. [View license](LICENSE.md).

0 comments on commit 0b4c71b

Please sign in to comment.