Skip to content

Commit ffc79c0

Browse files
committed
Added warning about fabbot could be wrong
1 parent 177bff3 commit ffc79c0

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

contributing/code/pull_requests.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -402,22 +402,25 @@ pressured to refactor your code immediately when someone provides feedback.
402402
Automated Feedback
403403
~~~~~~~~~~~~~~~~~~
404404

405-
There are many automated scripts that will provide feedback on your PR.
405+
There are many automated scripts that will provide feedback on a pull request.
406406

407407
fabbot
408408
""""""
409409

410-
`fabbot`_ will review code style, check for common typos and make sure your git
410+
`fabbot`_ will review code style, check for common typos and make sure the git
411411
history looks good. If there are any issues, fabbot will often suggest what changes
412412
that should be done. Most of the time you get a command to run to automatically
413413
fix the changes.
414414

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+
415418
Psalm
416419
"""""
417420

418-
`Psalm`_ will make a comment on your Pull Request if it discovers any potential
421+
`Psalm`_ will make a comment on a pull request if it discovers any potential
419422
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-``
423+
and discussed. A pull request should not update the Psalm baseline nor add ``@psalm-``
421424
annotations.
422425

423426
After the `Psalm phar is installed`_, the analysis can be run locally with:

0 commit comments

Comments
 (0)