Skip to content

Commit 02910f4

Browse files
committed
Updated contribution guide with "Automated Feedback"
1 parent cd5d590 commit 02910f4

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

contributing/code/pull_requests.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -399,6 +399,33 @@ The :doc:`core team </contributing/code/core_team>` is responsible for deciding
399399
which PR gets merged, so their feedback is the most relevant. So do not feel
400400
pressured to refactor your code immediately when someone provides feedback.
401401

402+
Automated Feedback
403+
~~~~~~~~~~~~~~~~~~
404+
405+
There are many automated scripts that will provide feedback on your PR.
406+
407+
fabbot
408+
""""""
409+
410+
`fabbot`_ will review code style, check for common typos and make sure your git
411+
history looks good. If there is any issues, fabbot will often suggest what changes
412+
that should be done. Most of the time you get a command to run to automatically
413+
fix the changes.
414+
415+
Psalm
416+
"""""
417+
418+
`Psalm`_ will make a comment on your Pull Request if it discover any potential
419+
type errors. The Psalm errors are not always correct, but each should be reviewed
420+
and discussed. A Pull Request should not update the psalm baseline nor add ``@psalm-``
421+
annotations.
422+
423+
Psalm can run locally with:
424+
425+
.. code-block:: terminal
426+
427+
$ psalm src/Symfony/Component/Workflow
428+
402429
.. _rework-your-patch:
403430

404431
Rework your Pull Request
@@ -430,6 +457,7 @@ before merging.
430457
.. _Symfony repository: https://github.com/symfony/symfony
431458
.. _`documentation repository`: https://github.com/symfony/symfony-docs
432459
.. _`fabbot`: https://fabbot.io
460+
.. _`Psalm`: https://psalm.dev/
433461
.. _`PSR-1`: https://www.php-fig.org/psr/psr-1/
434462
.. _`PSR-2`: https://www.php-fig.org/psr/psr-2/
435463
.. _`searching on GitHub`: https://github.com/symfony/symfony/issues?q=+is%3Aopen+

0 commit comments

Comments
 (0)