Skip to content

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

Open
MikeMcC399 wants to merge 1 commit into
nodejs:mainfrom
MikeMcC399:docs/jq-required
Open

docs: add jq (JSON processor) contributor requirement#2599
MikeMcC399 wants to merge 1 commit 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.

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.

2 participants