Updating documentation about linters. #981
Conversation
.github/CONTRIBUTING.md
Outdated
| @@ -124,8 +124,9 @@ In addition, linters can help to enforce coding standards, find unused variables | |||
|
|
|||
| **HospitalRun** uses the following linters: | |||
|
|
|||
| 1. [ESLint](http://eslint.org/) for ECMAScript/JavaScript. You can find the ESLint User guide [here](http://eslint.org/docs/user-guide/). | |||
| 1. [ESLint](http://eslint.org/) for ECMAScript/JavaScript. You can find the ESLint User guide [here](http://eslint.org/docs/user-guide/). In addition to the default set of rules ESLint is setup to use eslint-plugin-ember-suave you can find more information about that [here](https://github.com/DockYard/eslint-plugin-ember-suave). | |||
There was a problem hiding this comment.
We need a link here to Dockyard's Ember.js style guide:
https://github.com/DockYard/styleguides/blob/master/engineering/ember.md
This has more helpful information than the eslint-plugin-ember-suave page.
There was a problem hiding this comment.
Thanks for the PR @sweeneydavidj!
As noted below, we need to emphasize that this project adheres to Dockyard's Ember.js Style Guide and link to that information because that will be helpful for developers trying to understand the rules used by ESLint.
.github/CONTRIBUTING.md
Outdated
| @@ -124,8 +124,9 @@ In addition, linters can help to enforce coding standards, find unused variables | |||
|
|
|||
| **HospitalRun** uses the following linters: | |||
|
|
|||
| 1. [ESLint](http://eslint.org/) for ECMAScript/JavaScript. You can find the ESLint User guide [here](http://eslint.org/docs/user-guide/). | |||
| 1. [ESLint](http://eslint.org/) for ECMAScript/JavaScript. You can find the ESLint User guide [here](http://eslint.org/docs/user-guide/). In addition to the default set of rules ESLint is setup to use eslint-plugin-ember-suave you can find more information about that [here](https://github.com/DockYard/eslint-plugin-ember-suave). | |||
| 2. [stylelint](http://stylelint.io/) for Stylesheets. You can find stylelint User guide [here](http://stylelint.io/user-guide/). | |||
There was a problem hiding this comment.
Can you correct the grammar here to You can find the stylelint user guide here
…Ember.js style guide.
|
@jkleinsc thanks for the review! I've added in the changes that you mentioned. |
There was a problem hiding this comment.
Thanks for updating the PR. After seeing the changes, I think this statement belongs at the beginning of the document where it was instead of down in the linters section. Maybe clean it up to segue into the linters statement? Something like this?
This project uses the style guides from Dockyard for Ember and JavaScript. These style guides are enforced via ESLint, which is one of the linters...
|
@jkleinsc I've added in those changes, hopefully that reads better now. |
There was a problem hiding this comment.
Looks good to me @sweeneydavidj. Thanks for the PR! I'll merge it in.
Fixes: Consolidation and updating of documentation about linters used in the project.
Changes proposed in this pull request:
cc @HospitalRun/core-maintainers