From 2ecd8b60928ca4e32234293124531634c0b12892 Mon Sep 17 00:00:00 2001 From: Mike Farah Date: Sun, 24 Mar 2024 11:29:48 +1100 Subject: [PATCH] updated contribe guide --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 17fab63e..94cd04c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Development +.# Development 1. Install (Golang)[https://golang.org/] 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. +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 - 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: