Merge pull request #14 from gimlet-io/dev-instructions

Build instructions

README.md

@@ -36,7 +36,7 @@ See all [Examples](/examples/deploying-an-image)
 
 Thank you for your interest in contributing to the Gimlet project.
 
-Below are some of the guidelines and best practices for contributing to this repository:
+Below are some guidelines and best practices for contributing to this repository:
 
 ### Issues
 
@@ -54,3 +54,22 @@ If you have any ideas on new features or want to improve the existing features,
 * Create a new branch and make your changes.
 * Open a pull request with detailed commit message and reference issue number if applicable.
 * A maintainer will review your pull request, and help you throughout the process.
+
+## Development
+
+Development of OneChart does not differ from developing a regular Helm chart.
+
+The source for OneChart is under `charts/onechart` where you can locate the `Chart.yaml`, `values.yaml` and the templates.
+
+We write unit tests for our helm charts. Pull requests are only accepted with proper test coverage.
+
+The tests are located under `charts/onechart/test` and use the https://github.com/DataDog/helm-unittest.git Helm plugin to run the tests.
+
+For installation, refer to the CI workflow at `.github/workflows/build.yaml`
+TODO: move it to the Makefile
+
+## Release process
+
+`make all` to test and package the Helm chart.
+The chart archives are put under `docs/` together with the Helm repository manifest (index.yaml)
+It is then served with Github Pages on https://chart.onechart.dev