Add some development notes to the README for now.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
This commit is contained in:
parent
787cf47c39
commit
76a44ecd58
27
README.md
27
README.md
@ -1,3 +1,30 @@
|
||||
# placeholder-name
|
||||
|
||||
Copyright 2020 VMware, Inc.
|
||||
|
||||
## Developing
|
||||
|
||||
### Running Lint
|
||||
|
||||
```cmd
|
||||
./hack/module.sh lint
|
||||
```
|
||||
|
||||
### Running Tests
|
||||
|
||||
```cmd
|
||||
./hack/module.sh unittest
|
||||
```
|
||||
|
||||
### Pre-commit hooks
|
||||
|
||||
This project uses the [pre-commit] to agree on some conventions about whitespace/file encoding.
|
||||
|
||||
```cmd
|
||||
$ brew install pre-commit
|
||||
[...]
|
||||
$ pre-commit install
|
||||
pre-commit installed at .git/hooks/pre-commit
|
||||
```
|
||||
|
||||
[pre-commit]: https://pre-commit.com/
|
||||
|
Loading…
Reference in New Issue
Block a user