MetaMask / MetaMask/contributor-docs

Add guidance for package maintenance

Offen
#113 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

category-documentation github-migration-triaged team-wallet-framework wf-documentation
Vorherrschende Sprache
JavaScript
Sterne
86
Forks
42
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die vorhandene Dokumentation für Mitwirkende und die verlinkten SemVer-Richtlinien zu prüfen, und ermittle anschließend, wo Hinweise zur Paketpflege hingehören. Behandle die Modulvorlage, Versionierung, Changelogs, Tests von Vorabversionen, Abhängigkeitstypen sowie die im Issue aufgeführten lokalen und CI-Workflows. Als erledigt gilt die Aufgabe, wenn diese Themen für Paketbeitragende klar dokumentiert sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
55/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.