Adds a pre-commit config (#3)
- adds a pre-commit config - includes prettier formatting configuration - fixes title in README - adds a CircleCI config - sets default pre-commit stage to commit
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
# Speckle Repo Management Templates
|
||||
# Speckle Pre-Commit Hooks
|
||||
|
||||
[](https://twitter.com/SpeckleSystems) [](https://discourse.speckle.works) [](https://speckle.systems) [](https://speckle.guide/dev/)
|
||||
|
||||
@@ -17,6 +17,7 @@ Comprehensive developer and user documentation for Speckle can be found in our:
|
||||
## Usage
|
||||
|
||||
1. Add the following to your `.pre-commit-config.yaml` file:
|
||||
|
||||
```
|
||||
- repo: https://github.com/specklesystems/pre-commit
|
||||
rev: '0.1.0'
|
||||
@@ -27,11 +28,14 @@ Comprehensive developer and user documentation for Speckle can be found in our:
|
||||
## Developing & Debugging
|
||||
|
||||
1. install:
|
||||
- `git`
|
||||
- `pre-commit`
|
||||
|
||||
- `git`
|
||||
- `pre-commit`
|
||||
|
||||
1. Git clone this repository. Detailed steps on how to do that can be found on [GitHub's documentation](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls).
|
||||
1. In a terminal, `cd` into a directory containing code that you wish to try the pre-commit hook on. e.g. Speckle's `speckle-server` repository.
|
||||
1. Run the following command to run a pre-commit hook directly from this repository. Replace `<pre-commit hook to run>` with the name of the hook you wish to run:
|
||||
|
||||
```shell
|
||||
pre-commit try-repo ./path/to/cloned/specklesystems/pre-commit <pre-commit hook to run>
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user