suyiiyii/yq
1
0
Fork 0
mirror of https://github.com/mikefarah/yq.git synced 2024-12-19 20:19:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Mike Farah 2020-02-21 21:16:47 +11:00 committed by GitHub
parent b286636909
commit b0d1afb601
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -1,6 +1,8 @@
1. Install (golang)[https://golang.org/]
1. Run `scripts/devtools.sh` to install the required devtools 1. Run `scripts/devtools.sh` to install the required devtools
2. Run `make [local] vendor` to install the vendor dependencies 2. Run `make [local] vendor` to install the vendor dependencies
3. Write unit tests - see existing examples 2. Run `make [local] test` to ensure you can run the existing tests
4. Make the code updates 3. Write unit tests - (see existing examples). Changes will not be accepted without corresponding unit tests.
4. Make the code changes.
5. `make [local] test` to lint code and run tests 5. `make [local] test` to lint code and run tests
6. profit. ok no profit, but raise a PR and get kudos :) 6. Profit! ok no profit, but raise a PR and get kudos :)