Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Commit

Permalink
added steps using Makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
sa-ChristianAnton committed Jun 12, 2022
1 parent 9f7bc56 commit 7cde286
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@

# Contributing

* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](docs/requirements.md).
* Have the ``make`` command and *docker* installed on your system. With this, you don't need the below mentioned ``helm`` and ``helm-docs`` and use containers for the needed steps instead.
* [OPTIONAL] Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](docs/requirements.md).
* [OPTIONAL] Configure authentication on your Github account to use the SSH protocol instead of HTTP. Watch this tutorial to learn how to set up: https://help.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account
* Create a fork this repository.
* Clone the forked repository to your local system:
Expand Down Expand Up @@ -37,7 +38,30 @@ git branch
```

* Make your changes and tests to the new branch.
* Verify your changed do not introduce syntactical/semantic errors:

Method using make and docker:
```bash
make lint
````

Method using locally installed ``helm`` command:
```bash
helm lint .
```

* Run command ``helm-docs`` to update content of ``README.md`` file using the ``README.md.gotmpl`` template. More info about [helm-docs](https://github.com/norwoodj/helm-docs).

Method using make and docker:
```bash
make gen-docs
```

Method using locally installed ``helm-docs`` command:
```bash
helm-docs
```

* Commit the changes to the branch.
* Push files to repository remote with command:

Expand Down

0 comments on commit 7cde286

Please sign in to comment.