Browse Source

style(hyperdrive.php): improve code quality

activate mess detector and wp coding standards

relates to #29
Josh Habdas 2 years ago
parent
commit
51f105cc1e
2 changed files with 4 additions and 4 deletions
  1. 2
    0
      .codeclimate.yml
  2. 2
    4
      README.md

+ 2
- 0
.codeclimate.yml View File

@@ -13,6 +13,8 @@ engines:
13 13
     enabled: true
14 14
   phpmd:
15 15
     enabled: true
16
+    config:
17
+      rulesets: "cleancode,codesize,design,naming,unusedcode"
16 18
 ratings:
17 19
   paths:
18 20
   - "**.php"

+ 2
- 4
README.md View File

@@ -58,11 +58,9 @@ Hyperdrive accepts any issue. Be it gratuitously worded, devoid of information o
58 58
 
59 59
 Please open issues when creating PRs and PR against the issue to close it. This helps establish a need (the issue) and helps separate it from the implementation (the pull), resulting in more robust solutions and helps ensure ongoing code quality.
60 60
 
61
-Pulls submitted to Hyperdrive should adhere to [WordPress Coding Standards](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards) and, additionally, all [standards subsets](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards#standards-subsets), including, but not limited to: `Core`, `Docs`, `Extra` and `VIP`.
61
+Pull requests will be statically analyzed to identify code smells and style inconsistencies, and a report generated automatically each time a change is made on a branch. See [`.codeclimate.yml`](https://github.com/comfusion/hyperdrive/blob/master/.codeclimate.yml) for a listing of analysis engines and configured rulesets.
62 62
 
63
-Adherence to standards are monitored programmatically using [`PHP_CodeSniffer`](https://github.com/squizlabs/PHP_CodeSniffer) in conjunction with [Code Climate](https://codeclimate.com/). Pull requests will automatically be sniffed for code smell upon submission and feedback on code quality and conformance made available automatically whenever possible.
64
-
65
-If you plan on contributing code please install [EditorConfig](http://editorconfig.org/) for your editor or IDE to help normalize your code with our coding standards before submitting pulls.
63
+Before working on a pull please install and configure [EditorConfig](http://editorconfig.org/) for your editor or IDE to help normalize your code syntax with that of the project.
66 64
 
67 65
 ## License
68 66
 

Loading…
Cancel
Save