R1.6 · One reference plugin per format

Offen
#119 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
35/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
go

Rechercherichtung

Start with docs/plugins.md and docs/writing-a-plugin.md to identify the supported formats and existing examples. Then inspect the plugin directories, tests, and testdata samples, along with the new-plugin work in R1.3. Done means every format has one short, tested reference plugin, the references are documented, and generator output matches the relevant reference.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

story

Part of epic R1 · Public repos that wow (linked as parent issue).

Story

As a contributor, I want one small, well-commented reference plugin for each format, so I can copy the right example instead of reading a large real one.

Subtasks

  • List the formats (changelog, API changelog, feed, OpenAPI, migration guide, retirements, removed members, ...)
  • For each, pick or write one short reference plugin with comments on every step
  • Each reference has a test and a small testdata sample
  • new-plugin (R1.3) uses the reference for the chosen format as its base
  • Link the references from docs/writing-a-plugin.md

Acceptance criteria

  • Every format has exactly one reference plugin marked as such in docs/plugins.md
  • Each reference is short enough to read in a few minutes and its tests pass
  • new-plugin output matches the reference for its format
Vorherrschende Sprache
Go
Sterne
0
Forks
0
Ø Merge
2 Std. 59 Min.
Gemergte PRs (30 T.)
17

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus patch-it-dev/patch-it-plugins

Alle Issues in patch-it-dev/patch-it-plugins

Ähnliche Issues

Weitere Issues zu Go

Neue Issues direkt in Ihr Postfach

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