nodejs / nodejs/node-core-utils
Add ncu-env-check
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 314
- Fork
- 137
- Merge medio
- 2g 8h
- PR unite (30g)
- 24
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando i punti di ingresso CLI esistenti in node-core-utils e determina come viene registrato un nuovo comando ncu-env-check. Usa la checklist Linux in questo issue come criteri di accettazione iniziali, includendo i remoti Git, l’identità Git, gli strumenti necessari e la chiave SSH di GitHub. Il lavoro è completato quando un solo comando indica se l’ambiente è pronto per contribuire a Node.js.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript
- Ambito
- cli, tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100