mirrors/pinniped
1
0
Fork 0
mirror of https://github.com/vmware-tanzu/pinniped.git synced 2025-12-23 06:15:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add some development notes to the README for now.

Browse Source 
Signed-off-by: Matt Moyer <moyerm@vmware.com>
This commit is contained in:
Matt Moyer
2020-08-14 14:47:39 -05:00
parent 787cf47c39
commit 76a44ecd58
1 changed files with 27 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -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/