Skip to content

Commit 01ac615

Browse files
committed
Updating contrib
1 parent 6629924 commit 01ac615

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,20 @@
1-
.# Development
1+
# Before you begin
2+
Not all new PRs will be merged in
3+
4+
It's recommended to check with the owner first (e.g. raise an issue) to discuss a new feature before developing, to ensure your hard efforts don't go to waste.
5+
6+
PRs to fix bugs and issues are almost always be welcome, just make sure you write tests as well.
7+
8+
** PRs that significantly refactor code and release pipelines PRs will generally _NOT_ be accepted **
9+
10+
Significant refactors take a lot of time to understand and can have all sorts of unintended side effects.
11+
12+
Release pipeline PRs are a security risk - it's too easy for a serious vulnerability to sneak in (either intended or not). If there is a new cool way of releasing things, raise an issue for discussion first - it will need to be gone over with a fine tooth comb.
13+
14+
At this stage, yq is not going to maintain any other release platforms other than GitHub and Docker - that said, I'm more than happy to put in other community maintained methods in the README for visibility :heart:
15+
16+
17+
# Development
218

319
1. Install (Golang)[https://golang.org/]
420
1. Run `scripts/devtools.sh` to install the required devtools
@@ -12,15 +28,14 @@
1228

1329
# Documentation
1430

15-
The documentation is a bit of a mixed bag (sorry in advance, I do plan on simplifying it...) - with some parts automatically generated and stiched together and some statically defined.
16-
17-
Documentation is written in markdown, and is published in the 'gitbook' branch.
18-
1931
The various operator documentation (e.g. 'strings') are generated from the 'master' branch, and have a statically defined header (e.g. `pkg/yqlib/doc/operators/headers/add.md`) and the bulk of the docs are generated from the unit tests e.g. `pkg/yqlib/operator_add_test.go`.
2032

2133
The pipeline will run the tests and automatically concatenate the files together, and put them under
2234
`pkg/qylib/doc/add.md`. These files are checked in the master branch (and are copied to the gitbook branch as part of the release process).
2335

36+
37+
Remaining static documentation is in the 'githook' branch (where the generated docs are copied across into)
38+
2439
## How to contribute
2540

2641
The first step is to find if what you want is automatically generated or not - start by looking in the master branch.

0 commit comments

Comments
 (0)