Add guidance for package maintenance
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 55/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Tranquilo
- Stack tecnológico
- javascript
- Área
- documentation
Línea de trabajo
Comienza revisando la documentación existente para contribuidores y las indicaciones de SemVer enlazadas; después, identifica dónde debe incluirse la guía sobre el mantenimiento de paquetes. Cubre la plantilla del módulo, el versionado, los changelogs, las pruebas de versiones preliminares, los tipos de dependencias y los flujos de trabajo locales y de CI enumerados en el issue. Se considera terminado cuando estos temas están documentados claramente para los contribuidores de paquetes.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Cover topics like:
- Use the module template
- Follow SemVer
- Changelog maintenance
- Testing prerelease builds locally and on CI
- e.g. yarn link or file:// for local, preview builds for CI
- dependencies vs peerDependencies vs devDependencies
Notes:
This message was on Slack and should be included in the guidelines in some way:
PSA: There are two primary ways that we communicate changes we've make to our NPM packages to consumers. Changelogs are one of them, but we also use versions as a coarse indicator as well. I have seen several instances over time where a version for a released package was bumped in a way that either oversells or undersells the changes inside of that release. For instance:
- Bumping the minor part of a version if new functionality was not being added, when only the patch should have been bumped
- Bumping only the patch part of a version when new functionality was added, when the minor should have been bumped
- Not bumping the major part of a version when breaking changes are introduced
As a reminder, we use SemVer to assign new versions for packages. I would recommend everyone read this when they get a chance, especially the "Why Use" section and the FAQ.
- Lenguaje dominante
- JavaScript
- Estrellas
- 88
- Forks
- 44
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de MetaMask/contributor-docs
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 62/100
MetaMask/contributor-docs#164 ·
-
category-documentation github-migration-triaged team-wallet-framework wf-documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
MetaMask/contributor-docs#115 · 1 comentario ·
-
issueAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 10/100
MetaMask/contributor-docs#169 ·
-
team-core-platform
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
MetaMask/contributor-docs#157 · 1 comentario ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 15/100
MetaMask/contributor-docs#142 ·
Todos los issues de MetaMask/contributor-docs
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Los mantenedores suelen responder en 8 días
-
docs(stream-protocol): document messageMetatadata on start/finish and the message-metadata chunkAbiertofactory-active task-identify-harness-labels-done task-identify-issue-type-done
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
vercel/ai#23375 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
feature request
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
-
docs hacktoberfest help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
pacocartones/free-llm-api-hub#347 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
wpilibsuite/wpilib-docs#3378 ·
Los mantenedores suelen responder en 1 día