From 1ef2617ebb1ab7befd683c2cb7ba5663c33583dd Mon Sep 17 00:00:00 2001 From: Matthieu Lempereur Date: Tue, 5 Mar 2024 11:30:54 +0100 Subject: [PATCH 1/2] checklist for bridges initial pr --- contributing/code/create_bridge.rst | 55 +++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 contributing/code/create_bridge.rst diff --git a/contributing/code/create_bridge.rst b/contributing/code/create_bridge.rst new file mode 100644 index 00000000000..12a7e25f047 --- /dev/null +++ b/contributing/code/create_bridge.rst @@ -0,0 +1,55 @@ +Create a new bridge for Mailer, Translation or Notifier Component +================================================================= + +.. admonition:: Screencast + :class: screencast + + Do you prefer video tutorials? Check out the `Contributing Back To Symfony`_ + screencast series. + +Creating a new bridge for a Symfony Component requires a number of changes to the +code and possibly the Symfony documentation. To help the contributors along the way, +we have created this checklist of things to keep in mind. + +Update code +----------- + +* Add the Transport factory to ``UnsupportedSchemeException`` and +``UnsupportedSchemeExceptionTest`` of the component; +* Add the Transport factory to the ``FACTORY_CLASSES`` constant of the component's +``Transport`` class; +* The ``#[\SensitiveParameter]`` attribute should be used for sensitive properties; +* Check if the classes defined in :class:`Symfony\\Bundle\\FrameworkBundle\\DependencyInjection\\FrameworkExtension` is the same as the ones +declared in component's transports configuration; +* The year in the copyright should be the current year. + +Update recipes +-------------- + +* TBD + +Update documentation +-------------------- + +Bridges are not documented with code documentation, you can use the component's +readme file to add some informations about how to use it. However components +documentation requires some updates in order to stay up to date. + +For a Mailer Bridge + +* Add the new Bridge in third party transport's list; +* Add the available DSN formats in the relevant list; +* Indicate whether the new Bridge supports tags and metadata; +* If your Bridge supports Webhook add it in its documentation. + +For a Notifier Bridge + +* Add the new Bridge in the list for the relevant channel; +* If your Bridge supports Webhook add it in its documentation. + +For a Translation Bridge + +* Add the new Bridge in the translation providers list; +* Add the available DSN formats in the corresponding list. + +.. _`Contributing Back To Symfony`: https://symfonycasts.com/screencast/contributing From a0fdfc7ac94d671498af03ed7a2a67b3881c0284 Mon Sep 17 00:00:00 2001 From: Matthieu Lempereur Date: Tue, 5 Mar 2024 11:34:13 +0100 Subject: [PATCH 2/2] fix ci --- contributing/code/create_bridge.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing/code/create_bridge.rst b/contributing/code/create_bridge.rst index 12a7e25f047..4c4fce82e22 100644 --- a/contributing/code/create_bridge.rst +++ b/contributing/code/create_bridge.rst @@ -32,7 +32,7 @@ Update documentation -------------------- Bridges are not documented with code documentation, you can use the component's -readme file to add some informations about how to use it. However components +readme file to add some information about how to use it. However components documentation requires some updates in order to stay up to date. For a Mailer Bridge pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy