pat-s c46bf7c60f Format README (#408 )

Some small formatting changes which are auto-applied by the markdown code styler in vscode (which I am using a lot).

These are also present in #407.
Merging this before/in general would help be a bit when tinkering with the README.
Mainly indentation related, plus some single quotes -> double quotes changes.

Co-authored-by: pat-s <patrick.schratz@gmail.com>
Reviewed-on: https://gitea.com/gitea/helm-chart/pulls/408
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-by: techknowlogick <techknowlogick@noreply.gitea.io>
Co-authored-by: pat-s <pat-s@noreply.gitea.io>
Co-committed-by: pat-s <pat-s@noreply.gitea.io>

2023-03-08 03:50:40 +08:00

2.5 KiB

Raw Blame History

Contribution Guidelines

Any type of contribution is welcome; from new features, bug fixes, tests, refactorings for easier maintainability or documentation improvements.

Development environment

node at least current LTS
helm
make is optional; you may call the commands directly

When using Visual Studio Code as IDE, following plugins might be useful:

Documentation Requirements

The README.md must include all configuration options. The parameters section is generated by extracting the parameter annotations from the values.yaml file, by using this tool.

If changes were made on configuration options, run make readme to update the README file.

Pull Request Requirements

When submitting or updating a PR:

make sure it passes CI builds.
do not make independent changes in one PR.
try to avoid rebases. They make code reviews for large PRs and comments much harder.
if applicable, use the PR template for a well-defined PR description.
clearly mark breaking changes.

Local development & testing

For local development and testing of pull requests, the following workflow can be used:

Install minikube and helm.
Start a minikube cluster via minikube start.
From the gitea/helm-chart directory execute the following command. This will install the dependencies listed in Chart.yml and deploy the current state of the helm chart found locally. If you want to test a branch, make sure to switch to the respective branch first. helm install --dependency-update gitea . -f values.yaml.
Gitea is now deployed in minikube. To access it, it's port needs to be forwarded first from minikube to localhost first via kubectl --namespace default port-forward svc/gitea-http 3000:3000. Now Gitea is accessible at http://localhost:3000.

Unit tests

# install the unittest plugin
$ helm plugin install https://github.com/heyhabito/helm-unittest

# run the unittests
make unittests

2.5 KiB Raw Blame History