nodejs / nodejs/node-core-utils

Add ncu-env-check

Ouverte
#554 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
JavaScript
Étoiles
314
Forks
137
Merge moyen
2 j 8 h
PR mergées (30 j)
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
  • 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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par localiser les points d’entrée CLI existants dans node-core-utils et déterminer comment une nouvelle commande ncu-env-check est enregistrée. Utilisez la checklist Linux de cet issue comme critères d’acceptation initiaux, notamment les dépôts distants Git, l’identité Git, les outils requis et la clé SSH GitHub. Le travail est terminé lorsqu’une seule commande indique si l’environnement est prêt à contribuer à Node.js.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript
Domaine
cli, tooling
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.