Skip to content

Commit 14bb95b

Browse files
committed
Updated contribution guide with "Automated Feedback"
1 parent 1692ffa commit 14bb95b

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
@@ -400,6 +400,33 @@ The :doc:`core team </contributing/code/core_team>` is responsible for deciding
400400
which PR gets merged, so their feedback is the most relevant. So do not feel
401401
pressured to refactor your code immediately when someone provides feedback.
402402

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

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

0 commit comments

Comments
 (0)