Skip to content

docs: fix README contributor guidance#2000

Open
abdollahShahid wants to merge 1 commit into
kyverno:mainfrom
abdollahShahid:docs-align-node-version
Open

docs: fix README contributor guidance#2000
abdollahShahid wants to merge 1 commit into
kyverno:mainfrom
abdollahShahid:docs-align-node-version

Conversation

@abdollahShahid
Copy link
Copy Markdown

@abdollahShahid abdollahShahid commented May 9, 2026

Updates the README contributor guidance to reflect the current website repository setup. This PR Aligns the documented Node.js prerequisite with the repo configuration and development guide, Updates the policy rendering docs link to point to the tracked scripts/README.md, Replaces stale release-version instructions that referenced params.toml with the current src/constants/version.ts workflow & Corrects the cherry-pick command from git --cherry-pick <commit> to git cherry-pick <commit>.

These changes help contributors and maintainers follow the README without using outdated files, stale links, or invalid commands.

Copilot AI review requested due to automatic review settings May 9, 2026 11:37
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the contributor prerequisites in the root README so they match the repository’s configured Node.js engine requirement, helping new contributors choose the correct Node version when setting up locally.

Changes:

  • Update README “Contributing” prerequisite from Node v22+ to Node.js v24 (linked to the v24 announcement).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@abdollahShahid abdollahShahid force-pushed the docs-align-node-version branch 2 times, most recently from 17add73 to 125e65c Compare May 9, 2026 12:05
@abdollahShahid abdollahShahid changed the title docs: align Node.js prerequisite in README docs: fix README contributor guidance May 9, 2026
Signed-off-by: Muhammad Abdullah Shahid <108458621+abdollahShahid@users.noreply.github.com>
@abdollahShahid abdollahShahid force-pushed the docs-align-node-version branch from 125e65c to 70fce73 Compare May 9, 2026 12:26
@Suhani95
Copy link
Copy Markdown
Contributor

Suhani95 commented May 13, 2026

@abdollahShahid Great documentation refresh overall. One small question: should this be v24+ instead of strictly v24? Asking to ensure the README stays aligned with the actual engine and CI compatibility expectations.

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