Skip to content

Commit

Permalink
CI: Move pre-commit readme to top level readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeffrey-Vervoort-KNMI committed Jan 11, 2024
1 parent 5636d9a commit 14a0c4d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 20 deletions.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,20 @@ The E-SOH service consist of three parts.
- The records api will serve all metadata for each timeseries available in E-SOH.

## Usage
All three parts of the service is kept in this repository and can be built and setup using docker-compose. For more documentation on each part of the service see README.md in each relevant folder in this repository.
All three parts of the service is kept in this repository and can be built and setup using docker-compose. For more documentation on each part of the service see README.md in each relevant folder in this repository.

## Pre-commit

### Setup

1. Go to the root of the repository.
2. Install the python pre-commit package with `pip install pre-commit`.
3. Reinitialize the repository with `git init`.
4. Install the hooks defined in `.pre-commit-config.yaml` with `pre-commit install`.

### Useful Commands

- To update the pre-commit hooks in `.pre-commit-config.yaml`, run `pre-commit autoupdate`
- To apply the pre-commit for every file in the repository, run `pre-commit run --config './.pre-commit-config.yaml' --all-files`
- To see all options to `pre-commit run`, run `pre-commit help run` (in particular, the `--files` option can be used to apply the command to selected files only).
- To commit without the pre-commit hook, run `git commit -m "Some message" --no-verify`
19 changes: 0 additions & 19 deletions datastore/README.md

This file was deleted.

0 comments on commit 14a0c4d

Please sign in to comment.