@@ -399,6 +399,36 @@ The :doc:`core team </contributing/code/core_team>` is responsible for deciding
399
399
which PR gets merged, so their feedback is the most relevant. So do not feel
400
400
pressured to refactor your code immediately when someone provides feedback.
401
401
402
+ Automated Feedback
403
+ ~~~~~~~~~~~~~~~~~~
404
+
405
+ There are many automated scripts that will provide feedback on a pull request.
406
+
407
+ fabbot
408
+ """"""
409
+
410
+ `fabbot `_ will review code style, check for common typos and make sure the git
411
+ history looks good. If there are 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
+ It is rare, but fabbot could be wrong. One should verify if the suggested changes
416
+ make sense and that they are related to the pull request.
417
+
418
+ Psalm
419
+ """""
420
+
421
+ `Psalm `_ will make a comment on a pull request if it discovers any potential
422
+ type errors. The Psalm errors are not always correct, but each should be reviewed
423
+ and discussed. A pull request should not update the Psalm baseline nor add ``@psalm- ``
424
+ annotations.
425
+
426
+ After the `Psalm phar is installed `_, the analysis can be run locally with:
427
+
428
+ .. code-block :: terminal
429
+
430
+ $ psalm.phar src/Symfony/Component/Workflow
431
+
402
432
.. _rework-your-patch :
403
433
404
434
Rework your Pull Request
@@ -430,8 +460,10 @@ before merging.
430
460
.. _Symfony repository : https://github.com/symfony/symfony
431
461
.. _`documentation repository` : https://github.com/symfony/symfony-docs
432
462
.. _`fabbot` : https://fabbot.io
463
+ .. _`Psalm` : https://psalm.dev/
433
464
.. _`PSR-1` : https://www.php-fig.org/psr/psr-1/
434
465
.. _`PSR-2` : https://www.php-fig.org/psr/psr-2/
435
466
.. _`searching on GitHub` : https://github.com/symfony/symfony/issues?q=+is%3Aopen+
436
467
.. _`Symfony Slack` : https://symfony.com/slack-invite
437
468
.. _`Travis-CI` : https://travis-ci.org/symfony/symfony
469
+ .. _`Psalm phar is installed` : https://psalm.dev/docs/running_psalm/installation/
0 commit comments