From 16f0a8cb87863cc2d5df7f01a085e10aa87edff1 Mon Sep 17 00:00:00 2001 From: Iain Sproat <68657+iainsproat@users.noreply.github.com> Date: Wed, 8 Feb 2023 19:01:47 +0000 Subject: [PATCH] docs(README): Update contribution prerequisites --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 04977da..8161adf 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,14 @@ This doesn't make sense here, but in general, we should try to provide a small " Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md) and [code of conduct](.github/CODE_OF_CONDUCT.md) for an overview of the practices we try to follow. +#### Prerequisites + +1. Your code must pass our pre-commit checks in order to be accepted. + 1. Install [pre-commit](https://pre-commit.com/#install). + 1. In your shell terminal, `cd` to the root directory of this repository. + 1. Run `pre-commit install`. + 1. Review the output and adjust your contribution as necessary. + ### Community This Helm Chart is maintained by Speckle. The Speckle Community hangs out on [the forum](https://discourse.speckle.works), do join and introduce yourself & feel free to ask us questions!