Add ncu-env-check

オープン
#554 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
javascript
領域
cli, tooling

調査の方向性

まず、node-core-utils にある既存の CLI エントリポイントを見つけ、新しい ncu-env-check コマンドがどのように登録されるかを確認します。この issue の Linux チェックリストを初期受け入れ基準として使用し、Git のリモート、Git の ID、必要なツール、GitHub SSH キーを含めます。1 つのコマンドで環境が Node.js へのコントリビューションに対応できる状態かどうかを報告できれば完了です。

索引モデルが issue の本文から書いたものです。

説明

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
  • origin is set to something that's not git@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))
  • upstream is set to git@github.com:nodejs/node.git
  • check that git config user.name is set
  • check that git config user.email is 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.

主要言語
JavaScript
スター
313
フォーク
137
平均マージ
2日 8時間
マージ済み PR（30日）
24

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

nodejs/node-core-utils のほかの issue

nodejs/node-core-utils の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。