Skip to content

Commit c53c4bd

Browse files
committed
Update documentation to mention GNU make targets
1 parent 76c12e1 commit c53c4bd

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

docs/en/reference/index.rst

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,22 @@ Testing
127127
=======
128128

129129
If you are contributing to the Doctrine Coding Standard and want to test your contribution, you just
130-
need to execute PHP_CodeSniffer with the tests folder and ensure it matches the expected report:
130+
need to execute the ``test`` GNU make target:
131131

132132
.. code-block:: bash
133133
134-
$ ./vendor/bin/phpcs tests/input --report=summary --report-file=phpcs.log; diff tests/expected_report.txt phpcs.log
134+
$ make test
135+
136+
Sometimes you are enabling a sniff that enforces some features for a specific PHP version, that will
137+
probably cause our build pipeline to fail when running on such versions.
138+
139+
We have created the ``update-compatibility-patch`` GNU make target to help you with that:
140+
141+
.. code-block:: bash
142+
143+
$ make update-compatibility-patch
144+
145+
That target will apply the latest version of our compatibility patch and ask you to adjust the code in ``tests/fixed`` and
146+
``tests/expected_report.txt`` using the editor of your preference.
147+
Once you are done, please type "y" to resume the command, which will update the compatibility patch and create a commit
148+
with your changes for you to push to your remote branch.

0 commit comments

Comments
 (0)