Update readme #42
Update readme #42
Conversation
| cc @abbyarmada |
README.md Outdated
| phpcodesniffer: | ||
| enabled: true | ||
| config: | ||
| standard: "phpcs.ruleset.xml" |
There was a problem hiding this comment.
Does this information also live on our docs site? If so, should we link there to avoid going out of sync?
There was a problem hiding this comment.
Nope it doesn't. The doc site has trailed the Readme
There was a problem hiding this comment.
Was actually going to add a link in the other direction
There was a problem hiding this comment.
Was it intentional to make this a first-class section? I think it'd be simpler to do what we do for PHPMD, by including a relative-ruleset in the existing example configuration.
engines: phpmd: enabled: true config: file_extensions: "php" rulesets: "unusedcode,codesize,naming,optional_relative_path_to_custom_ruleset.xml"There was a problem hiding this comment.
Meh. I think it could merit its own section here since there's also a section specifically devoted to standards besides the default (PSR1 and PSR2) that we support but don't feel strongly.
There was a problem hiding this comment.
it could merit its own section here since there's also a section specifically devoted to standards besides the default (PSR1 and PSR2) that we support
I probably wouldn't agree with that reasoning: the config showing an example of specifying a coding standard, then a section listing the available standards makes sense -- you need both those pieces of distinct information. But an example showing that you can point to a relative file stands alone. Having it out in another section with additional copy and another config example block isn't analogous, IMO.
Maybe someone like @leftees should be the ultimate reviewer on this PR.
ABaldwinHunter force-pushed the abh-readme branch from 43daf23 to c53c5a6 Compare ABaldwinHunter force-pushed the abh-readme branch from c53c5a6 to e9f3ce1 Compare | @leftees made explanation smaller as discussed. Ready for another look! |
| LGTM @ABaldwinHunter |
See individual commits for changes.
@codeclimate/review