Skip to content

Commit ca88ad0

Browse files
authored
Merge pull request #285 from greg0ire/contributing
2 parents 7903671 + d690625 commit ca88ad0

File tree

2 files changed

+29
-8
lines changed

2 files changed

+29
-8
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributing
2+
3+
See https://www.doctrine-project.org/projects/doctrine-coding-standard/en/stable/reference/index.html#contributing

docs/en/reference/index.rst

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -117,14 +117,24 @@ and `the list of configuration options <https://github.com/squizlabs/PHP_CodeSni
117117

118118
To learn about customizing the rules, please refer to the :ref:`customizing` chapter.
119119

120+
Contributing
121+
============
122+
120123
Versioning
121-
==========
124+
----------
122125

123126
This library follows semantic versioning, and additions to the code ruleset
124127
are only performed in major releases.
125128

129+
The patch branch can receive internal changes, such as CI pipeline
130+
improvements, test workflow improvements, and can receive bugfixes. For
131+
instance, such as removing rules that were not meant to be added.
132+
133+
The minor branch can receive refactorings, and dependency updates that
134+
do not affect the code ruleset.
135+
126136
Testing
127-
=======
137+
-------
128138

129139
If you are contributing to the Doctrine Coding Standard and want to test your contribution, you just
130140
need to execute the ``test`` GNU make target:
@@ -136,13 +146,21 @@ need to execute the ``test`` GNU make target:
136146
Sometimes you are enabling a sniff that enforces some features for a specific PHP version, that will
137147
probably cause our build pipeline to fail when running on such versions.
138148

139-
We have created the ``update-compatibility-patch`` GNU make target to help you with that:
149+
We have created the ``update-compatibility-patch-*`` GNU make targets to
150+
help you with that. For instance, for PHP 6.0, you would run
140151

141152
.. code-block:: bash
142153
143-
$ make update-compatibility-patch
154+
$ make update-compatibility-patch-60
155+
156+
That target will attempt to apply the latest version of our
157+
compatibility patch for that version of PHP and ask you to adjust the
158+
code in ``tests/fixed`` and ``tests/expected_report.txt`` using the
159+
editor of your preference.
160+
161+
If the patch does not apply cleanly, you can edit it to edit or remove
162+
hunks that relate to files you changed in your PR.
144163

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.
164+
Once you are done, please type "y" to resume the command, which will
165+
update the compatibility patch and create a commit with your changes for
166+
you to push to your remote branch.

0 commit comments

Comments
 (0)