Skip to content

Commit

Permalink
docs: Add pre-requisites for local development (#182)
Browse files Browse the repository at this point in the history
Signed-off-by: Jose Valdes <[email protected]>
  • Loading branch information
jrvaldes authored Apr 25, 2023
1 parent 7f034f6 commit 1fecacd
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
- [How to uninstall KEDA OLM Operator](#how-to-uninstall-keda-olm-operator)
- [Monitoring](#monitoring)
- [Development](#development)
- [Pre-requisites](#pre-requisites)
- [Operator Framework](#operator-framework)
- [Running locally](#running-locally)
- [Building the Operator Image](#building-the-operator-image)
Expand Down Expand Up @@ -345,6 +346,26 @@ the Monitoring API are available in the cluster.

## Development

### Pre-requisites

This project uses the following tools for development.

#### golangci-lint

To install `golangci-lint` locally follow the [official documentation](https://golangci-lint.run/usage/install/#local-installation).

#### pre-commit

To install `pre-commit` locally follow the [official documentation](https://pre-commit.com/#install).
`pre-commit` uses the [.pre-commit-config.yaml](.pre-commit-config.yaml) configuration file located in the root of the
project.

To set up the `git` hook script execute the following command so that the pre-commit steps runs automatically on
each commit.
```bash
pre-commit install
```

### Operator Framework

This operator was created using the
Expand Down

0 comments on commit 1fecacd

Please sign in to comment.