huanld/seq-input-gelf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(README): Update contribution prerequisites

Browse Source
This commit is contained in:
Iain Sproat
2023-02-08 19:01:47 +00:00
parent 22b3b66838
commit 16f0a8cb87
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8
View File
@@ -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!