Checklist for new Mailer/Translation/Notifier bridges

symfony / symfony-docs

The Symfony documentation

https://symfony.com/doc

Other

2.16k stars 5.11k forks source link

Checklist for new Mailer/Translation/Notifier bridges #19433

Open OskarStark opened 8 months ago

OskarStark commented 8 months ago

          > @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 https://github.com/symfony/symfony/issues/53573#issuecomment-1898014575

xabbuh commented 8 months ago

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 commented 8 months ago

The Year in the copyright should be the current year

Mostly copy pasted from old bridges

OskarStark commented 8 months ago

#[\SensitiveParameter] should be used for sensitive properties

OskarStark commented 8 months ago

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 commented 8 months ago

Check the FrameworkExtension.php (classes defined in the class maps may be accidentally different than the ones declared in Resources/config/notifier_transports.php (same for the other ones) ?

javiereguiluz commented 8 months ago

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

OskarStark commented 8 months ago

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

Anyone willing to create an initial PR?