From 14a0c4d648f61d5954b9def6e173f08d00389a96 Mon Sep 17 00:00:00 2001 From: Jeffrey Vervoort Date: Thu, 11 Jan 2024 14:34:46 +0100 Subject: [PATCH] CI: Move pre-commit readme to top level readme. --- README.md | 18 +++++++++++++++++- datastore/README.md | 19 ------------------- 2 files changed, 17 insertions(+), 20 deletions(-) delete mode 100644 datastore/README.md diff --git a/README.md b/README.md index 17282305..d629b890 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +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` diff --git a/datastore/README.md b/datastore/README.md deleted file mode 100644 index d60ecc59..00000000 --- a/datastore/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# e-soh-datastore-poc - -E-SOH datastore PoCs - -## 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`