What You”ll Need
- GitHub account and familiarity with pull requests
- Fork of the nodejs/node repository (or write access if you”re a collaborator)
- Git installed locally and a working clone of your fork
- Signed Contributor License Agreement (CLA) if required by the project
- Basic knowledge of markdown and the project”s docs layout
How It Works
Adding a triager in Node.js documentation is primarily a repository documentation change: a contributor edits the collaborators/triage list (or the appropriate docs file), opens a pull request, and passes the project”s CI and review process. The actual commit recorded in v20.19.6 (“doc: add Miles Guicent as triager”) is an example of this simple workflow.
The workflow is lightweight: make a small markdown change, run local linters if available, open a PR that follows the project”s PR template, and request reviews from maintainers. After approval and passing CI, the change lands and is picked up in release notes for the next release.
![[nodejs] add triager](https://nodejs.org/static/images/logo-hexagon-card.png)
Step-by-Step Guide
[nodejs] add triager
- Fork & clone: fork nodejs/node on GitHub, then clone your fork locally (git clone & git remote setup) so you can edit files.
- Create a branch: create a focused branch, e.g. git checkout -b doc/add-triager-Miles-Guicent to isolate your change.
- Edit the docs: locate the collaborators/triagers file or the release notes source and add the new entry in markdown. Keep entry format consistent with existing items.
- Run checks locally: run any repo-provided linters, markdown checks, or docs build steps locally (npm run lint or similar) to catch formatting/CI issues early.
- Commit with a clear message: use conventional commit style (doc: add
as triager) and sign your commit if required by the project. - Open a PR: push the branch to your fork and open a pull request against nodejs/node. Use the project”s PR template and explain why the triager entry is being added.
- Address reviews & CI: respond to reviewer feedback, fix any CI failures (lint, spelling, file path), and update the PR until maintainers approve.
- Land the change: once approved and green, the maintainers or release team will merge the PR; the change will appear in the next release notes (e.g., v20.19.6 included this commit).
Use Cases & Examples
1) Adding a new triager after they complete onboarding: you update the triagers list with the new name and role note so release notes reflect their addition in the next release.
2) Correcting a triager”s listing: if someone”s entry is misspelled or in the wrong section, you open a small doc PR to move or rename the line; this is what the maintainers do for clean records.
3) Bulk documentation tidy before a release: you or a documentation team member perform a sweep of collaborator lists to add missing roles, standardize formatting, and ensure accurate release note entries; each change is a focused PR following the same process as the [nodejs] add triager example.
Common Issues
- CI lint failures: fix markdown style or spelling errors reported by CI and push an amended commit.
- Wrong file edited: verify the authoritative docs file (collaborators.md, collaborators list, or release-notes source) and update the correct path, then rebase if needed.
- CLA not signed: ensure your contributor agreement is signed (project-specific) — the PR bot will usually block merges until it”s complete.
- Merge conflicts on release branch: rebase your branch onto the target branch, resolve conflicts locally, and push the resolved branch for CI to re-run.
What”s Next
- Learn the release notes process so your doc change surfaces in the next release summary.
- Contribute to CONTRIBUTING.md or collaborator onboarding docs to streamline future triager additions.
- Explore more repo automation: add a checklist or GitHub Actions job to validate triager entries automatically.
Related Resources
- Parent release guide: https://nodejs.org/en/blog/release/v20.19.6 (release that contains commit e7f6f04758)
- Official Node.js docs and contributor guide: https://nodejs.org/docs/v20.19.6/api/ and the repository CONTRIBUTING.md