We are always looking to improve our documentation. If at some point you are reading the documentation and something is not clear, or you cannot find what you are looking for, then please open an issue. This gives us a chance to answer your question and to improve the documentation if needed.
Pull requests correcting spelling or grammar mistakes are always welcome.
We are currently tracking our documentation needs in Issue #10, which is a meta-issue that tracks all of our documentation issues.
Please try to answer at least the following questions when reporting a bug:
-
Which version of the project did you use when you noticed the bug?
You'll find this in your
package.json'sdevDependenciesasember-material-components-web. -
How do you reproduce the error condition?
-
What happened that you think is a bug?
-
What should it do instead?
Please provide some thoughtful commentary and code samples on what this feature should do, and why it should be added (your use case). The minimal questions you should answer when submitting a feature request should be:
-
What will it allow you to do that you can't do today?
-
Why do you need this feature and how will it benefit other users?
-
Are there any drawbacks to this feature?
Here are some things that will increase the chance that your pull request will be accepted:
-
Did you confirm this fix/feature is something that is needed?
-
Did you write automated tests?
-
Did you add documentation for the changes you made?
-
In lieu of a style guide, did you match your code style to the rest of the project?
If your pull request addresses an issue, then please add the corresponding issue's number ot the description of your pull request.
git clone git@github.com:secondstreet/ember-material-components-web.gitcd ember-material-components-webnpm install
npm test(Runsember try:eachto test your addon against multiple Ember versions)ember testember test --server
ember server
ember build
This document is heavily based on DockYard's contributing guidelines.