Contributing information #2792
Contributing information #2792
Conversation
petk
force-pushed
the
patch-git-rules
branch
from
a19cc58 to
aecb025
Compare
CONTRIBUTING.md
Outdated
| | PHP-7.0 | For releasing the PHP 7.0.x series. This is a current stable version and is open for bugfixes only. | | ||
| | PHP-5.6 | For releasing the PHP 5.6.x series. This is a current stable version and is open for security bugfixes only. | | ||
| | PHP-5.5 and below | These branches are closed. | | ||
| | PHP-X.Y.Z | These branches are used for the release managers for tagging the releases, hence they are closed to the general public. | |
There was a problem hiding this comment.
Not sure if this list should be here as it mandates some maintenance that is already done elsewhere. Maybe give only examples with X.Y.Z
There was a problem hiding this comment.
Table with branches removed since the text above is probably more descriptive, yes. And more future prone.
CONTRIBUTING.md
Outdated
| ``` | ||
|
|
||
| When you change the NEWS file for a bug fix, then please keep the bugs sorted in | ||
| decreasing order under the fixed version. |
There was a problem hiding this comment.
Unless you are going to commit it yourself, you shouldn't include the NEWS entry as it will probably create conflicts for the person merging it.
Contributing information has been joined from multiple text files into a single CONTRIBUTING.md file for convenience. The README.GIT-RULES file has been also used as a root indicator in two other files when building and is now changed to CONTRIBUTING.md instead. The CONTRIBUTING.md file is probably also the correct indicator for that instead. Other minor occurrences of the README.GIT-RULES file exist in the wiki pages which shouldn't be too complicated to refactor and point into the CONTRIBUTING.md file instead.
|
Some minor Markdown formatting has been fixed and information about the IMHO, this is explained better - for those wanting to do a "quick fix" and for people having commit access, of course thanks to all previous write-ups in those 3 files. In case there is anything confusing about this or not exactly clear, let me know. Thanks. |
|
I'll join two pull requests into one instead for easier understanding of the whole. Closing this pull request in favor of a new one... |
Hello,
after reading the
CONTRIBUTING.md,README.GIT-RULESandREADME.SUBMITTING-PATCHESfiles, it seems to me that some things mentioned need to be updated or at least simplified a bit. It would be of an enormous help for new people to understand better how/what/where and to reduce some cognitive load when browsing the php-src repository.As a first step, can we maybe refactor these 3 files into a single beginner friendly
CONTRIBUTING.mdfile and update it for the current contributing procedures but at the same time still have all the necessary information for the long term contributors?The
README.GIT-RULESfile is also used as a root indicator in two other files when building and is now changed toCONTRIBUTING.mdinstead. The CONTRIBUTING.md file is probably also the correct indicator for that instead since no other such file might appear in the repository. Other minor occurrences of theREADME.GIT-RULESfile exist in the wiki pages which shouldn't be too complicated to refactor and point into theCONTRIBUTING.mdfile instead.GitHub uses
CONTRIBUTING.mdfile when sending pull requests as an informational link.This pull request has refactored these files into a hopefully simpler but still informative approach to understand how to contribute to PHP. Any feedback is welcome here.
Thanks for checking this out.
Redacted: few other changes have been added and rebased.