mirror of https://github.com/mikefarah/yq.git
updated contribe guide
This commit is contained in:
parent
021d5f05f9
commit
2ecd8b6092
|
@ -1,4 +1,4 @@
|
||||||
# Development
|
.# Development
|
||||||
|
|
||||||
1. Install (Golang)[https://golang.org/]
|
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
|
||||||
|
@ -25,6 +25,8 @@ The pipeline will run the tests and automatically concatenate the files together
|
||||||
|
|
||||||
The first step is to find if what you want is automatically generated or not - start by looking in the master branch.
|
The first step is to find if what you want is automatically generated or not - start by looking in the master branch.
|
||||||
|
|
||||||
|
Note that PRs with small changes (e.g. minor typos) may not be merged (see https://joel.net/how-one-guy-ruined-hacktoberfest2020-drama).
|
||||||
|
|
||||||
### Updating dynamic documentation from master
|
### Updating dynamic documentation from master
|
||||||
- Search for the documentation you want to update. If you find matches in a `*_test.go` file - update that, as that will automatically update the matching `*.md` file
|
- Search for the documentation you want to update. If you find matches in a `*_test.go` file - update that, as that will automatically update the matching `*.md` file
|
||||||
- Assuming you are updating a `*_test.go` file, once updated, run the test to regenerated the docs. E.g. for the 'Add' test generated docs, from the pkg/yqlib folder run:
|
- Assuming you are updating a `*_test.go` file, once updated, run the test to regenerated the docs. E.g. for the 'Add' test generated docs, from the pkg/yqlib folder run:
|
||||||
|
|
Loading…
Reference in New Issue