Improved documentation #12
Merged
Conversation
This file contains 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
…ight years, updated badges
Potherca
requested changes
Feb 15, 2017
README.md
Outdated
| @@ -33,7 +31,7 @@ Add the following lines to your `composer.json` file: | |||
|
|
|||
| ## Developing Coding Standards | |||
|
|
|||
| Coding standard can be developed in the way [PHP_CodeSniffer] documents [this]. | |||
| Coding standard can be developed in the way [PHP_CodeSniffer][codesniffer] documents [this][tutorial]. | |||
There was a problem hiding this comment.
Please avoid using "this" for links. Suggestion:
Coding standard can be developed in the way [PHP_CodeSniffer][codesniffer] documents in their [tutorial page][tutorial].
README.md
Outdated
|
|
||
| For a full list off all author and/or contributors, please check [this page]. | ||
| For a full list off all author and/or contributors, please check [this page][contributors]. |
There was a problem hiding this comment.
Please avoid using "this" for links. Suggestion:
For a full list off all author and/or contributors, please check [the contributors page][contributors].
|
Changes look good. Minor request for change of existing text (see review comments). |
|
@Potherca Updated this PR with the requested changes |
Potherca
approved these changes
Feb 15, 2017
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.
Proposed Changes
Update documentation on several parts:
To match our Markdown code guidelines
Updated copyright years in preparation of the new release
Updated badges/shields
Related Issues
This PR prepares for a next release as requested in #11