Skip to content

Commit e84f09a

Browse files
committed
Fix lint errors
1 parent c25d276 commit e84f09a

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

docs/style-guides/javascript/README.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# JavaScript Style Guide
22

3-
> _An opinionated style guide for writing JavaScript._
3+
> *An opinionated style guide for writing JavaScript.*
44
55

66
## Table of Contents
@@ -37,11 +37,11 @@
3737

3838
## Introduction
3939

40-
Always abide by the __Law of Code Style Consistency__, or, in other words, _when in Rome, do as the Romans do_.
40+
Always abide by the __Law of Code Style Consistency__, or, in other words, *when in Rome, do as the Romans do*.
4141

4242
While the code base to which you want to contribute may be a horrific mess in terms of aesthetic appearance and style, style consistency takes precedent over personal preference and canon. The more consistent a code base is in terms of style, the more readers of the code can focus on what the code does rather than deciphering changes in style.
4343

44-
So, even if your peers commit various _faux pas_ outlined below, as long as you are contributing to their code base, abide by their conventions.
44+
So, even if your peers commit various *faux pas* outlined below, as long as you are contributing to their code base, abide by their conventions.
4545

4646
A code base--module, repository, application, library, etc--should always appear to have a single author and not be a schizophrenic franken-mess. This stated, for those opportunities where you are the primary author, you should lead by example and write clean, readable, and testable code.
4747

@@ -67,7 +67,7 @@ Hopefully, most of the conventions outlined below will help enable you to do so.
6767

6868
##### Reason
6969

70-
Tab indentation allows a developer to specify the space indentation equivalent in her editor. For example, in [Sublime Text][sublime-text], you can specify in your user preferences
70+
[Tab indentation][tab-indentation] allows a developer to specify the space indentation equivalent in her editor. For example, in [Sublime Text][sublime-text], you can specify in your user preferences
7171

7272
``` text
7373
"tab_width": 4
@@ -779,6 +779,7 @@ Code review.
779779

780780

781781
<!-- <rule-set> -->
782+
782783
---
783784

784785
## Strings
@@ -3028,6 +3029,7 @@ var robo = createRobot();
30283029

30293030

30303031
<!-- <rule-set> -->
3032+
30313033
---
30323034

30333035
## Setters and Getters
@@ -3439,9 +3441,9 @@ Often, more focused modules are available which can accomplish the same task. In
34393441

34403442
* In particular, avoid the following libraries:
34413443

3442-
* underscore
3443-
* lodash
3444-
* async
3444+
* underscore
3445+
* lodash
3446+
* async
34453447

34463448

34473449
##### Enforcement
@@ -3460,15 +3462,19 @@ Any dependency you use becomes __your__ responsibility. Demand the same level of
34603462

34613463
##### Notes
34623464

3463-
* While Github stars and downloads are rough indicators, place more emphasis on the following:
3465+
* While GitHub stars and downloads are rough indicators, place more emphasis on the following:
3466+
3467+
* Code quality
3468+
3469+
- conciseness
3470+
- maintainability
3471+
3472+
* Documentation
3473+
3474+
- APIs
3475+
- examples
34643476

3465-
* Code quality
3466-
- conciseness
3467-
- maintainability
3468-
* Documentation
3469-
- APIs
3470-
- examples
3471-
* Test cases
3477+
* Test cases
34723478

34733479
* For most cases, do __not__ place much weight on how recently the module was updated. Small, focused, well-written modules should not require much updating.
34743480

0 commit comments

Comments
 (0)