@@ -123,6 +123,13 @@ Versioning
123123This library follows semantic versioning, and additions to the code ruleset
124124are only performed in major releases.
125125
126+ The patch branch can receive internal changes, such as CI pipeline
127+ improvements, test workflow improvements, and can receive bugfixes. For
128+ instance, such as removing rules that were not meant to be added.
129+
130+ The minor branch can receive refactorings, and dependency updates that
131+ do not affect the code ruleset.
132+
126133Testing
127134=======
128135
@@ -136,13 +143,21 @@ need to execute the ``test`` GNU make target:
136143 Sometimes you are enabling a sniff that enforces some features for a specific PHP version, that will
137144probably cause our build pipeline to fail when running on such versions.
138145
139- We have created the ``update-compatibility-patch `` GNU make target to help you with that:
146+ We have created the ``update-compatibility-patch-* `` GNU make targets to
147+ help you with that. For instance, for PHP 6.0, you would run
140148
141149.. code-block :: bash
142150
143- $ make update-compatibility-patch
151+ $ make update-compatibility-patch-60
152+
153+ That target will attempt to apply the latest version of our
154+ compatibility patch for that version of PHP and ask you to adjust the
155+ code in ``tests/fixed `` and ``tests/expected_report.txt `` using the
156+ editor of your preference.
157+
158+ If the patch does not apply cleanly, you can edit it to edit or remove
159+ hunks that relate to files you changed in your PR.
144160
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.
161+ Once you are done, please type "y" to resume the command, which will
162+ update the compatibility patch and create a commit with your changes for
163+ you to push to your remote branch.
0 commit comments