nodejs / nodejs/node-core-utils
Add ncu-env-check
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 314
- Forks
- 137
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 24
Description
There's a pretty decent number of requirements to contribute to node that are easy to fumble. It would be lovely if node-core-utils provided a suite of checks that can be run with a single command (ncu-env-check) to validate that a given environment is properly configured.
Here's the list I have so far for Linux:
- system has git
- system has python3
- system has g++
- system has make
-
originis set to something that's notgit@github.com:nodejs/node.git(and potentially check if it's a fork of nodejs/node for even better DX, which could be checked via the API (thanks @zkatfor the tip <3)) -
upstreamis set togit@github.com:nodejs/node.git - check that
git config user.nameis set - check that
git config user.emailis set - check that an SSH key matching one published to GitHub is set
I'm sure there's a number of others that could be added, too.
This would be particularly useful if we are to follow through on https://github.com/nodejs/node/issues/39672, particularly for getting people up and running with minimal friction.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing CLI entry points in node-core-utils and determine how a new ncu-env-check command is registered. Use the Linux checklist in this issue as the initial acceptance criteria, including Git remotes, Git identity, required tools, and the GitHub SSH key. Done means one command reports whether the environment is ready for Node.js contribution.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- cli, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100