Skip to content

docs: add jq (JSON processor) contributor requirement - #2599

Merged
MikeMcC399 merged 2 commits into
nodejs:mainfrom
MikeMcC399:docs/jq-required
Aug 8, 2026
Merged

docs: add jq (JSON processor) contributor requirement#2599
MikeMcC399 merged 2 commits into
nodejs:mainfrom
MikeMcC399:docs/jq-required

Conversation

@MikeMcC399

@MikeMcC399 MikeMcC399 commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

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

  • Documentation
  • Version change (Update, remove or add more Node.js versions)
  • Variant change (Update, remove or add more variants, or versions of variants)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (none of the above)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING.md document.
  • All new and existing tests passed.

@MikeMcC399
MikeMcC399 marked this pull request as ready for review August 7, 2026 08:50

@MattIPv4 MattIPv4 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

jq was already used in the script prior to that change, so I'm surprised this hasn't been an issue before!

@MikeMcC399

Copy link
Copy Markdown
Contributor Author

@MattIPv4

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 nschonni left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@MikeMcC399
MikeMcC399 merged commit c038219 into nodejs:main Aug 8, 2026
3 checks passed
@MikeMcC399
MikeMcC399 deleted the docs/jq-required branch August 8, 2026 06:00
@MikeMcC399

Copy link
Copy Markdown
Contributor Author

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 ubuntu and debian:trixie-slim Docker images have sed & awk pre-installed, although they don't have jq.

Git for Windows includes Git Bash, which includes sed & awk.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants