I8.2 · Watch SendGrid

Ouverte
#52 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
48/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
go, openapi
Domaine
api, backend

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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
Langage dominant
Go
Étoiles
0
Forks
0
Merge moyen
2 h 59 min
PR mergées (30 j)
17

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de patch-it-dev/patch-it-plugins

Toutes les issues de patch-it-dev/patch-it-plugins

Issues similaires

Plus d'issues Go

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.