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

Document how to customize rules #86

Merged
merged 1 commit into from
Sep 5, 2018
Merged

Document how to customize rules #86

merged 1 commit into from
Sep 5, 2018

Conversation

Majkl578
Copy link
Contributor

@Majkl578 Majkl578 commented Sep 4, 2018

  • document phpcs.xml(.dist)?
  • document how to customize ruleset

@jwage Can you please proofread this? Thanks.

@Majkl578
Copy link
Contributor Author

Majkl578 commented Sep 4, 2018

Also can I easily test this locally (build the docs from my PR)?

@jwage
Copy link
Member

jwage commented Sep 4, 2018

Yes, go to the projects/coding-standard folder in your doctrine-website clone and checkout your clone & branch. Run ./bin/console build-docs --project=coding-standard then run ./bin/console build-website

<!-- set soft line length limit to 120 characters -->
<property name="lineLimit" value="120"/>
<!-- set hard line length limit to 120 characters -->
<property name="absoluteLineLimit" value="160"/>
Copy link
Member

Choose a reason for hiding this comment

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

Mismatch to documentation (120 vs. 160)

Adding new rules
----------------

Add new rules is simple, all you need to do is add a new ``<rule>`` block:
Copy link
Member

Choose a reason for hiding this comment

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

Adding

Project-level ruleset
=====================

To enable Doctrine Coding Standard for your project, create ``phpcs.xml.dist`` file with the following content:
Copy link
Member

Choose a reason for hiding this comment

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

"create a"

<file>lib</file>
<file>tests</file>

<!-- Include whole Doctrine Coding Standard -->
Copy link
Member

Choose a reason for hiding this comment

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

"whole" => "full|the whole"

composer.json Outdated Show resolved Hide resolved
@alcaeus alcaeus merged commit 2834369 into master Sep 5, 2018
@alcaeus
Copy link
Member

alcaeus commented Sep 5, 2018

🚢

@alcaeus alcaeus deleted the customizing-rules branch September 5, 2018 04:59
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

5 participants