yq/CONTRIBUTING.md

9 lines
479 B
Markdown
Raw Normal View History

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