Create CONTRIBUTING.md

This commit is contained in:
Mike Farah 2020-02-21 21:11:34 +11:00 committed by GitHub
parent 651d9edf88
commit 1cc20d52bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

6
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,6 @@
1. Run `scripts/devtools.sh` to install the required devtools
2. Run `make [local] vendor` to install the vendor dependencies
3. Write unit tests - see existing examples
4. Make the code updates
5. `make [local] test` to lint code and run tests
6. profit. ok no profit, but raise a PR and get kudos :)