Skip to content

Checklist for new Mailer/Translation/Notifier bridges #19433

Open
@OskarStark

Description

@OskarStark
          > @OskarStark I'm wondering if we should create a checklist of things we should not forget when adding a new mailer/notifier (and publish it in the docs). WDYT?

Makes sense, if I find some spare time, I will do it.

PS: Another option would be to have dedicated Carsonbot comment with the checklist when a new bridge is added

Originally posted by @OskarStark in symfony/symfony#53573 (comment)

Activity

xabbuh

xabbuh commented on Jan 18, 2024

@xabbuh
Member

Some things I have regular added in the past which are not that obvious (easy to miss):

  • add the transport factory to UnsupportSchemeException, UnsupportedSchemeExceptionTest
  • add the transport factory to the FACTORY_CLASSES constant of the component's Transport class
OskarStark

OskarStark commented on Jan 18, 2024

@OskarStark
ContributorAuthor
  • The Year in the copyright should be the current year

Mostly copy pasted from old bridges

OskarStark

OskarStark commented on Jan 18, 2024

@OskarStark
ContributorAuthor
  • #[\SensitiveParameter] should be used for sensitive properties
OskarStark

OskarStark commented on Jan 18, 2024

@OskarStark
ContributorAuthor
  • A PR against symfony/symfony-docs repo, maybe with an example (already merged PR)
  • A PR against symfony/recipes repo, maybe with an example (already merged PR)
smnandre

smnandre commented on Jan 18, 2024

@smnandre
Member
javiereguiluz

javiereguiluz commented on Jan 25, 2024

@javiereguiluz
Member

Folks, this issue looks mostly related to Symfony code, not docs, right?

OskarStark

OskarStark commented on Jan 25, 2024

@OskarStark
ContributorAuthor

Yes, but Fabien wants to have a checklist in the docs as first step.

Anyone willing to create an initial PR?

added
hasPRA Pull Request has already been submitted for this issue.
on Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    hasPRA Pull Request has already been submitted for this issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @javiereguiluz@OskarStark@smnandre@xabbuh

        Issue actions

          Checklist for new Mailer/Translation/Notifier bridges · Issue #19433 · symfony/symfony-docs