R1.6 · One reference plugin per format

Đang mở
#119 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
go

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
Go
Star
0
Fork
0
Merge trung bình
2 giờ 59 phút
Pull request đã merge (30 ngày)
17

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của patch-it-dev/patch-it-plugins

Tất cả issue của patch-it-dev/patch-it-plugins

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.