Add ncu-env-check

Abierto
#554 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
javascript
Área
cli, tooling

Línea de trabajo

Empieza por localizar los puntos de entrada CLI existentes en node-core-utils y determinar cómo se registra un nuevo comando ncu-env-check. Usa la lista de comprobación de Linux de este issue como criterios de aceptación iniciales, incluidos los remotos de Git, la identidad de Git, las herramientas necesarias y la clave SSH de GitHub. El trabajo estará terminado cuando un solo comando informe de si el entorno está listo para contribuir a Node.js.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
JavaScript
Estrellas
313
Forks
137
Merge medio
2 d 8 h
PR fusionados (30 d)
24

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de nodejs/node-core-utils

Todos los issues de nodejs/node-core-utils

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.