nodejs / nodejs/node-core-utils
Add ncu-env-check
还没有人认领这个 Issue。
- 主要语言
- JavaScript
- 星标
- 314
- 派生
- 137
- 平均合并
- 2 天 8 小时
- 30 天内合并 PR
- 24
描述
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.
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先定位 node-core-utils 中现有的 CLI 入口,并确定如何注册新的 ncu-env-check 命令。使用此 issue 中的 Linux 检查清单作为初始验收标准,包括 Git 远程仓库、Git 身份、所需工具以及 GitHub SSH 密钥。完成的标准是:一个命令能够报告环境是否已准备好为 Node.js 做贡献。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- javascript
- 领域
- cli, tooling
- Issue 类型
- 功能
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100