Skip to content

Conversation

frenck
Copy link
Contributor

@frenck frenck commented Feb 15, 2017

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

    • Added project stage badge
    • Added Scrutinizer badge
    • Added latests version on Packagist badge

Related Issues

This PR prepares for a next release as requested in #11

@frenck frenck self-assigned this Feb 15, 2017
@frenck frenck requested a review from Potherca February 15, 2017 09:48
README.md Outdated
## 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].
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
The original idea and setup of this repository is by [Franck Nijhof][frenck], employee @ Dealerdirect.

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].
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please avoid using "this" for links. Suggestion:

For a full list off all author and/or contributors, please check [the contributors page][contributors].

@Potherca
Copy link
Member

Does exactly what it says on the tin

Changes look good. Minor request for change of existing text (see review comments).

@frenck
Copy link
Contributor Author

frenck commented Feb 15, 2017

@Potherca Updated this PR with the requested changes

@frenck frenck merged commit 04746ad into master Feb 15, 2017
@frenck frenck deleted the documentation/serveral-improvements branch February 15, 2017 10:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants