From 43dccffa54a45643f5a294c0be5f52d0e6c7e62b Mon Sep 17 00:00:00 2001 From: Addy Osmani Date: Tue, 7 Apr 2015 10:40:20 +0100 Subject: [PATCH] Address feedback, add coding rules section --- CONTRIBUTING.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d6708d9..af15091b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,7 @@ We'd love for you to contribute to our source code and to make Material Design L - [Issues and Bugs](#issue) - [Feature Requests](#feature) - [Submission Guidelines](#submit) + - [Coding Rules](#rules) - [Signing the CLA](#cla) ## Code of Conduct @@ -20,11 +21,11 @@ We promise to extend courtesy and respect to everyone involved in this project r If any member of the community violates this code of conduct, the maintainers of the Material Design Lite project may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate. -If you are subject to or witness unacceptable behavior, or have any other concerns, please let us know on the tracker. +If you are subject to or witness unacceptable behavior, or have any other concerns, please drop us a line at addyo@google.com. ## Got a Question or Problem? -If you have questions about how to use Material Design Lite, please direct these to [StackOverflow][stackoverflow]. We are also available on GitHub issues. +If you have questions about how to use Material Design Lite, please direct these to [StackOverflow][stackoverflow] and use the `material-design-lite` tag. We are also available on GitHub issues. ## Found an Issue? If you find a bug in the source code or a mistake in the documentation, you can help us by @@ -142,7 +143,16 @@ from the main (upstream) repository: ```shell git pull --ff upstream master - `` + ``` + +## Coding Rules + +We generally follow the [Google JavaScript style guide](js-style-guide) with a few minor exceptions documented in our +[JSCS configuration.](jscs-config). + +[JSCS](http://jscs.info) is a tool for linting code against a style guide and has plugins available for both editors and build tools. Should +you find that you would prefer to automatically format your code to match our style guide, you can use the JSCS [autoformatting](autoformatting) +feature. ## Signing the CLA @@ -161,4 +171,5 @@ changes to be accepted, the CLA must be signed. It's a quick process, we promise [jsbin]: http://jsbin.com/ [stackoverflow]: http://stackoverflow.com/questions/tagged/material-design-lite [global-gitignore]: https://help.github.com/articles/ignoring-files/#create-a-global-gitignore - +[autoformatting]: https://medium.com/@addyosmani/auto-formatting-javascript-code-style-fe0f98a923b8 +[jscs-config]: https://github.com/google/material-design-lite/blob/master/.jscsrc