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

Update CONTRIBUTING.md to add linting guidance #146

Merged
merged 1 commit into from
Oct 5, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,16 +68,19 @@ functionality or fixing a bug, we need a test!

4. Make the test pass.

5. Document your code and make sure the documentation is still able to generate and creates the result you are
5. Make sure your code follows the [Ember.js Style Guide](https://github.com/softlayer/ember-style-guide). This addon leverages the [sl-eslint](https://github.com/joshforisha/sl-eslint) addon to
enforce compliance with these guides. Simply run `npm run lint-all` to confirm compliance.

6. Document your code and make sure the documentation is still able to generate and creates the result you are
expecting. This addon leverages the [ember-cli-jsdoc](https://github.com/softlayer/ember-cli-jsdoc) addon to
generate documentation. Simply run either `ember ember-cli-jsdoc` or `npm run docs` (shortcut setup in this repo)
and then visit *http://localhost:4200/docs*.

6. Commit your changes. If your pull request fixes an issue specify it in the commit message. Here's an example:
7. Commit your changes. If your pull request fixes an issue specify it in the commit message. Here's an example:
`git commit -m "Close #12 Fix passing of context"`.
[GitHub offers additional examples here.](https://help.github.com/articles/closing-issues-via-commit-messages/)

7. Push to your fork and submit a pull request againt the `master` branch. Please provide us with some explanation
8. Push to your fork and submit a pull request againt the `master` branch. Please provide us with some explanation
of why you made the changes you made. For new features make sure to explain a standard use case to us.

We try to be quick about responding to tickets but sometimes we get a bit backlogged. If the response is slow, try
Expand Down