R1.6 · One reference plugin per format

Aberta
#119 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
35/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
go

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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
Linguagem predominante
Go
Estrelas
0
Forks
0
Merge médio
2h 59min
PRs com merge (30d)
17

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de patch-it-dev/patch-it-plugins

Todas as issues de patch-it-dev/patch-it-plugins

Issues semelhantes

Mais issues de Go

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.