docs: add jq (JSON processor) contributor requirement - #2599
Conversation
MattIPv4
left a comment
There was a problem hiding this comment.
jq was already used in the script prior to that change, so I'm surprised this hasn't been an issue before!
You're right. I've changed the text in the OP accordingly. |
nschonni
left a comment
There was a problem hiding this comment.
I'll approve, but I think there are a bunch of other assumptions around sed/awk/git bash that we don't list that are likely more likely to trip people up.
This is also only really applicable till we finally rewrite in JS
I don't think that there is anything missing, but if you see something that does need additional documentation, please go ahead and submit a PR. As a rough cross-check, both Git for Windows includes Git Bash, which includes For Windows, we could put a more general note in CONTRIBUTING to say that any commands for Windows should be run under Git Bash. I'm not too worried about missing infos for contributors, since the numbers of contributors are very low. On the other hand, I'm just proposing incremental improvements to docs as I go on. |
Description
Add the requirement to the CONTRIBUTING to install jq using a link to https://jqlang.org/download/
Motivation and Context
PR #2598 adds additional usage of jq in the update.sh script.
Now if jq is not installed, a lot of error messages are output.
Testing Details
Get jq using the instructions on https://jqlang.org/download/ and execute
./update.sh.Types of changes
Checklist