From a91c497ee362769da8244f188d5d386c39d3f1f2 Mon Sep 17 00:00:00 2001 From: robhowley Date: Tue, 6 Aug 2024 09:55:40 -0400 Subject: [PATCH] update readme for pre-commit --- .github/workflows/ci.yaml | 1 - README.md | 10 +++++++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index de98ce2..1569c6d 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -1,7 +1,6 @@ name: CI on: push: - pull_request: jobs: test: diff --git a/README.md b/README.md index 5b8678a..a350195 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Runs on [git pages](https://pages.github.com/) using [jekyll](https://jekyllrb.c ## Local dev -Can run locally using docker compose. Run +### Running site locally ``` docker compose up @@ -19,3 +19,11 @@ docker compose up and go to [localhost:4000](http://localhost:4000/). Changes to the _content_ will live reload. _Note_: changes to the `_config.yml`, e.g. theme, or the `Gemfile` will require restarting the container. + +### pre-commit + +The linting steps that run in CI are available as pre-commit checks as well. To set them up run + +```shell +pre-commit install +```