Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Add guidance for package maintenance

Ouverte
  • Quelque chose ne va pas ?
#113 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
55/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Calme
Stack technique
javascript
Domaine
documentation

Piste de recherche

Commencez par examiner la documentation existante destinée aux contributeurs ainsi que les recommandations SemVer liées, puis identifiez où doit se trouver la documentation sur la maintenance des paquets. Couvrez le modèle de module, le versionnage, les changelogs, les tests des versions préliminaires, les types de dépendances ainsi que les workflows locaux et de CI listés dans l’issue. La tâche est considérée comme terminée lorsque ces sujets sont documentés clairement pour les contributeurs de paquets.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

category-documentation github-migration-triaged team-wallet-framework wf-documentation

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.

Langage dominant
JavaScript
Étoiles
88
Forks
43
Aucune PR mergée en 30 j

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de MetaMask/contributor-docs

Toutes les issues de MetaMask/contributor-docs

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.