Refactor README.md and contributing information #2833
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kelunik
reviewed
Oct 14, 2017
README.md
Outdated
| We do not merge pull requests directly on github. All PRs will be | ||
| pulled and pushed through http://git.php.net. | ||
| We do not merge pull requests directly on GitHub. All PRs will be pulled and | ||
| pushed through http://git.php.net. |
There was a problem hiding this comment.
@kelunik added in the following squashed commit. 👍 to README.md and CONTRIBUTING.md files.
petk
force-pushed
the
patch-readme-contributing
branch
2 times, most recently
from
3914f6f to
4c5ff6b
Compare
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. README.md file now includes short description of the php-src repository, some links to Git repository and GitHub mirror and short installation information. When creating windows builds, instead of the install.txt file the README.md file is attached instead as readme.txt for simplest possible opening and reading without too much Markdown syntax bariers. And some other minor fixes here and there: - https://git.php.net instead of http://git.php.net - Paragraph mentioning lxr and bonsai has been removed
petk
force-pushed
the
patch-readme-contributing
branch
from
4c5ff6b to
1fb1fe6
Compare
|
I'll come back around to this and read it ... seems okay at a glance ... |
|
This seems to be stuck a bit. Should I simplify this more/less? I was planning on adding other changes to the repository docs. |
|
I'm closing this one and will open separate pull requests for each step that was done here. I think the 3rd attempt to update and make these files more current and relevant will be more successful. Also currently there are already conflicts to merge this without rebasing commits. Cheers. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello,
In this pull request, the contributing information has been joined from multiple text files into a single
CONTRIBUTING.mdfile for convenience.The
README.GIT-RULESfile has been also used as a root indicator in two other files when building PHP and is now changed toCONTRIBUTING.mdinstead. TheCONTRIBUTING.mdfile is probably also the correct indicator for that instead. 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.README.mdfile now includes short description of the php-src repository, some links to Git repository and GitHub mirror and short installation information. Improvements inspired by other open source projects and Art of README.When creating windows builds, instead of the
install.txtfile, theREADME.mdfile is attached instead asreadme.txtfor simplest possible opening and reading information on Windows platform without too much Markdown syntax barriers.So, the
INSTALLandwin32/install.txtare also no longer required to be updated for each RC release from the php documentation script.This is related to:
#2792 and #2815
Discussion on PHP Internals mailing list: http://news.php.net/php.internals/100894
Changes are described also in the commit message.
Any feedback is welcome here. Thanks.