Starting a team for the package examples initiative
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 20/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- node.js
- Ambito
- documentation
Direzione di ricerca
Start by reviewing the proposal and its references to nodejs/package-maintenance, nodejs/node-addon-examples, and e18e.dev. Clarify whether this repository should form a new team or a subteam, then define the team name, membership rules, and temporary write-access arrangement. Done means the organizational scope and setup plan have been agreed.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Proposed goals of this initiative:
- Identify and document package shipping patterns in the ecosystem (e.g. how people write their package.json). This is primarily about patterns in generic Node.js packages. For specific patterns of packages developed for various frameworks, or plugin packages etc. this repository can point readers to credible sources, but the source of truth for them should be hosted elsewhere (ideally in respective projects themselves).
- Write and maintain guides/tutorials/examples in this repository on how to ship various kind of packages e.g. how to write package.json for different consumers, how to perform certain package migrations e.g. from shipping CJS to shipping ESM. Personally I am a fan of the mini tutorial book + folders full of working examples approach in https://github.com/nodejs/node-addon-examples and I hope we can do something similar here.
- Providing a venue for folks to discuss about the patterns and ask questions about package shipping, and aid ecosystem cleanup efforts such as https://e18e.dev/
This is largely inspired by the NAPI effort, I think the NAPI team did a great job in putting out practical guides and resources for the NAPI migration, which was indispensable for the success of NAPI, and I hope we can learn from their success to help with the CJS -> ESM migration :)
Previously there was the @nodejs/package-maintenance team but the goals in https://github.com/nodejs/package-maintenance look very different and have a different audience. So I propose that we start a new team, which could be either a subteam under @nodejs/package-maintenance or just a different one, ideally involving maintainers of package tooling/package managers into the discussions to make sure that we are on the same page. Maybe it can be called @nodejs/package-examples , or @nodejs/package-patterns or a better name? (personally, it feels weird to me to have "examples" in the name of a team, so @nodejs/package-patterns sounds better).
About the joining this team: from previous experience (e.g. starting the automation team), I learned that if we just create a team and just add anyone who sign up to the team (i.e. including those who were not participating in anything in the organization), it's easy to end up with a team where most people were only active during the signup phase and after that >80% of the people don't respond to pings, and we ended up disbanding the largely inactive team and formed a smaller team with those who were active instead. To prevent that from happening again, I propose that we set up some simple rules:
- Anyone already in @nodejs/package-maintenance @nodejs/loaders @nodejs/tsc (and other related teams that I am forgetting, feel free to nominate) can be added directly
- Anyone who's not already part of 1 can be nominated by existing members with a simple explanation issue about why they should join.
While we are setting up this team, I propose that we grant write access to @nodejs/package-maintenance @nodejs/loaders and @nodejs/tsc to this repository, and the reviews etc. are delegated to existing teams. After the new team has gone through the initial setup phase and we have something up and going, we can switch the write access to that team.
- Lingua principale
- JavaScript
- Stelle
- 87
- Fork
- 11
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
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.
Altre issue di nodejs/package-examples
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
nodejs/package-examples#17 · 11 commenti · 1 reazione ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
nodejs/package-examples#2 · 8 commenti · 4 reazioni ·
Tutte le issue di nodejs/package-examples
Issue simili
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
avniproject/avni-client#2135 ·
-
automated broken-link
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
-
agent/security hive/hosted-available-lke648397-260827-5n31 security
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
babalae/bettergi-scripts-list#3674 ·
-
A-Release-Notes C-Editing D-Modest S-Ready-For-Implementation
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
bevyengine/bevy-website#2595 ·