Skip to content

Fix/documentation md#2178

Open
Naveen-Boddepalli wants to merge 2 commits into
Priyanshu-byte-coder:mainfrom
Naveen-Boddepalli:fix/documentation-md
Open

Fix/documentation md#2178
Naveen-Boddepalli wants to merge 2 commits into
Priyanshu-byte-coder:mainfrom
Naveen-Boddepalli:fix/documentation-md

Conversation

@Naveen-Boddepalli

Copy link
Copy Markdown
Contributor

Summary

Fixed the reported bug plus a second one hiding in plain sight. All changes made:
Reported fix — Node version (line 11)

Node.js >= 18 → Node.js >= 20 to match package.json engines field

Bonus fix — npm → pnpm (6 locations)
package.json explicitly sets "packageManager": "pnpm@9.0.0", but DEVELOPMENT.md told contributors to use npm everywhere. This would cause pnpm's lockfile (pnpm-lock.yaml) to be ignored, potentially installing wrong dependency versions or breaking the workspace setup. Locations fixed:

Closes #2173


Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Refactor / code cleanup

Changes Made

fixed the documentation of documentation.md file


How to Test

the fixed documentation will have correct versions.


Screenshots (if UI change)

N/A


Checklist

  • Linked issue in summary
  • npm run lint passes locally
  • No TypeScript errors (npm run type-check)
  • Self-reviewed the diff
  • Added/updated tests if applicable

Accessibility Checklist

  • Proper keyboard navigation tested
  • Responsive UI verified
  • Accessibility labels added where needed

Additional Notes

This update standardizes pull request submissions and helps maintain consistent review quality across contributions.

@vercel

vercel Bot commented Jun 7, 2026

Copy link
Copy Markdown

@Naveen-Boddepalli is attempting to deploy a commit to the PRIYANSHU DOSHI's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added gssoc26 GSSoC 2026 contribution type:bug GSSoC type bonus: bug fix type:docs GSSoC type bonus: documentation (+5 pts) labels Jun 7, 2026
@github-actions

github-actions Bot commented Jun 7, 2026

Copy link
Copy Markdown

GSSoC Label Checklist 🏷️

@Priyanshu-byte-coder — please apply the appropriate labels before merging:

Difficulty (pick one):

  • level:beginner — 20 pts
  • level:intermediate — 35 pts
  • level:advanced — 55 pts
  • level:critical — 80 pts

Quality (optional):

  • quality:clean — ×1.2 multiplier
  • quality:exceptional — ×1.5 multiplier

Validation (required to score):

  • gssoc:approved — counts for points
  • gssoc:invalid / gssoc:spam / gssoc:ai-slop — does not score

Type labels (type:*) are auto-detected from files and title. Review and adjust if needed.
Points formula: (difficulty × quality_multiplier) + type_bonus

@Priyanshu-byte-coder

Copy link
Copy Markdown
Owner

This PR has merge conflicts with main. The ssrf-protection.ts changes have already been merged via #2176. Please rebase and remove the SSRF changes, keeping only the documentation improvements:

git fetch origin
git rebase origin/main

@Naveen-Boddepalli

Copy link
Copy Markdown
Contributor Author
  • resolved the conflicts, please review them.

@Priyanshu-byte-coder Priyanshu-byte-coder added gssoc:approved GSSoC: PR approved for scoring level:beginner GSSoC: Beginner difficulty (20 pts) labels Jun 9, 2026
@Priyanshu-byte-coder

Copy link
Copy Markdown
Owner

Hi! This PR has merge conflicts with the main branch. Could you please rebase or merge main into your branch to resolve them? We'd love to get this merged! 🚀

git fetch upstream
git rebase upstream/main
# resolve any conflicts
git push --force-with-lease

If you're no longer working on this, let us know and we can close it. Thanks!

@Naveen-Boddepalli

Copy link
Copy Markdown
Contributor Author

resolved conflicts ✅

@Priyanshu-byte-coder

Copy link
Copy Markdown
Owner

The project CI uses npm ci and has package-lock.json, not pnpm-lock.yaml. Changing docs to reference pnpm while CI uses npm would confuse contributors. Either migrate CI to pnpm first, or remove the packageManager field from package.json.

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

Labels

gssoc:approved GSSoC: PR approved for scoring gssoc26 GSSoC 2026 contribution level:beginner GSSoC: Beginner difficulty (20 pts) type:bug GSSoC type bonus: bug fix type:docs GSSoC type bonus: documentation (+5 pts)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug] Node.js version mismatch: DEVELOPMENT.md says >=18 but package.json requires >=20

2 participants