nodejs / nodejs/node-core-utils
Add ncu-env-check
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 314
- Forks
- 137
- Ø Merge
- 2 T. 8 Std.
- Gemergte PRs (30 T.)
- 24
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die vorhandenen CLI-Einstiegspunkte in node-core-utils zu lokalisieren und festzustellen, wie ein neuer ncu-env-check-Befehl registriert wird. Verwende die Linux-Checkliste in diesem Issue als anfängliche Abnahmekriterien, einschließlich Git-Remotes, Git-Identität, erforderlicher Tools und des GitHub-SSH-Schlüssels. Fertig ist die Aufgabe, wenn ein einziger Befehl meldet, ob die Umgebung für einen Beitrag zu Node.js bereit ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript
- Bereich
- cli, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100