Update Styling Guide in Contributing Docs
Baraa Hamodi committed
May 17, 2015 at 23:38 UTC
00342dfc2687c6f00e2dfbc041230d9fe1b99c3f
1 file changed
+10
-5
CONTRIBUTING.md
+10
-5
@@ -27,7 +27,7 @@ The core team will be monitoring for pull requests. When we get one, we'll run s
27
28
In order to accept your pull request, we need you to submit a CLA. You only need to do this once, so if you've done this for another Facebook open source project, you're good to go. If you are submitting a pull request for the first time, just let us know that you have completed the CLA and we can cross-check with your GitHub username.
29
30
-[Complete your CLA here](https://code.facebook.com/cla)
30
+[Complete your CLA here.](https://code.facebook.com/cla)
31
32
## Bugs
33
@@ -50,15 +50,20 @@ Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
50
51
## Style Guide
52
53
-### Code
53
+Our linter will catch most styling issues that may exist in your code.
54
+You can check the status of your code styling by simply running: `grunt lint`
55
55
-* Use semicolons;
56
-* Commas last,
56
+However, there are still some styles that the linter cannot pick up. If you are unsure about something, looking at [Airbnb's Style Guide](https://github.com/airbnb/javascript) will guide you in the right direction.
57
+
58
+### Code Conventions
59
+
60
+* Use semicolons `;`
61
+* Commas last `,`
62
* 2 spaces for indentation (no tabs)
63
* Prefer `'` over `"`
64
* `'use strict';`
65
* 80 character line length
61
-* "Attractive"
66
+* Write "attractive" code
67
* Do not use the optional parameters of `setTimeout` and `setInterval`
68
69
### Documentation