Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Rename example script #35

Merged
merged 2 commits into from Aug 15, 2017
Merged

Conversation

GaryJones
Copy link
Contributor

The script will install (register) one or more Standards to PHP CodeSniffer, not the individual Sniffs.

Proposed Changes

Rename the script example in the Docs to clarify intent.

Optionally, it calls also be called register-codestandards, since the installation of the files has already been done by Composer, and this script would just re-register the Standard with PHP CodeSniffer. I've left it as install-codestandards for now though, as it may be perceived to be easier to remember, even if not technically accurate.

The script will install (register) one or more Standards to PHP CodeSniffer, not the individual Sniffs.
@GaryJones GaryJones changed the title Docs: Rename script example Docs: Rename example script Aug 2, 2017
@Potherca
Copy link
Member

Potherca commented Aug 2, 2017

Looks good to me. If @frenck agrees this can be merged/tagged/released.

@Potherca
Copy link
Member

Potherca commented Aug 2, 2017

It might be smart to change the jargon in the wiki as well:

To gain more widespread support for PHPCodeSniffer installers (not just this project) it is important that maintainers of custom codesniffs adapt using the "type" : "phpcodesniffer-standard" in their project's composer.json. 1

Adding the following line to the composer.json will make it possible for such packages to install this custom sniff using composer 2

Copy link
Contributor

@frenck frenck left a comment

Choose a reason for hiding this comment

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

+1

@Potherca Potherca merged commit e2f3158 into PHPCSStandards:master Aug 15, 2017
@Potherca
Copy link
Member

I've also updated the wiki entries mentioned above.

@GaryJones Thanks for your edits! 👍

@GaryJones GaryJones deleted the patch-1 branch August 15, 2017 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants