I8.2 · Watch SendGrid

Đang mở
#52 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/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, openapi
Lĩnh vực
api, backend

Hướng nghiên cứu

Start with CONTRIBUTING.md and the existing provider plugins to learn the catalog format, golden tests, and provider page template. Verify SendGrid’s official sources and versioning scheme, recording a check date and leaving unknown details as TBD. Add source catalog entries, fixtures including one historical breaking change, providers/sendgrid.md, and the docs/plugins.md row; done means the acceptance criteria pass and the client fix needed is documented.

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

Mô tả

good first issue story

Part of https://github.com/patch-it-dev/patch-it-plugins/issues/11

Story

As a developer whose code calls SendGrid, I want patch-it to know when SendGrid breaks, deprecates or retires something, so I get the fix before production does.

Subtasks

  • Find SendGrid's sources and record them with the date checked (verify, don't guess; leave TBD if unknown):
    • deprecations / sunset page
    • API changelog (RSS / Atom if there is one)
    • OpenAPI spec, if published
    • official SDKs and their release notes / changelogs (Python and JS first)
    • API versioning scheme (date-based, path, header, none)
  • Pick the format plugin for each source (OpenAPI, RSS, GitHub Releases, changelog file, registry, prose) and add catalog lines
  • Golden test: a saved copy of each source in, the expected events out
  • One real historical breaking change as a replay fixture
  • Provider page providers/sendgrid.md from the template
  • Add or update its row in docs/plugins.md (see CONTRIBUTING.md)
  • Note what the client needs to fix it (existing handler, or a new fix kind in the client)

Acceptance criteria

  • Daily ingest emits SendGrid events, each with source_url and an exact source_excerpt
  • The replayed historical change produces the right events
  • The provider page lists every source with its date checked
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.