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.

Sign up for GitHub

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

Anchors in markdown heading #52

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+19 −40
Open

Anchors in markdown heading #52

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13685dd
Update links in documentation
nisusam Oct 22, 2018
62166f1
Use hyphen(-) instead of underscore(_) for Github Markdown Heading An…
nisusam Oct 22, 2018
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
59 changes: 19 additions & 40 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,43 +20,39 @@ The details in this guide have been very heavily inspired by several existing st

## Table of Contents

* [The CoffeeScript Style Guide](#guide)
* [Code Layout](#code_layout)
* [Tabs or Spaces?](#tabs_or_spaces)
* [Maximum Line Length](#maximum_line_length)
* [Blank Lines](#blank_lines)
* [Trailing Whitespace](#trailing_whitespace)
* [Optional Commas](#optional_commas)
* [The CoffeeScript Style Guide](#coffeescript-style-guide)
* [Code Layout](#code-layout)
* [Tabs or Spaces?](#tabs-or-spaces)
* [Maximum Line Length](#maximum-line-length)
* [Blank Lines](#blank-lines)
* [Trailing Whitespace](#trailing-whitespace)
* [Optional Commas](#optional-commas)
* [Encoding](#encoding)
* [Module Imports](#module_imports)
* [Whitespace in Expressions and Statements](#whitespace)
* [Module Imports](#module-imports)
* [Whitespace in Expressions and Statements](#whitespace-in-expressions-and-statements)
* [Comments](#comments)
* [Block Comments](#block_comments)
* [Inline Comments](#inline_comments)
* [Naming Conventions](#naming_conventions)
* [Block Comments](#block-comments)
* [Inline Comments](#inline-comments)
* [Naming Conventions](#naming-conventions)
* [Functions](#functions)
* [Strings](#strings)
* [Conditionals](#conditionals)
* [Looping and Comprehensions](#looping_and_comprehensions)
* [Extending Native Objects](#extending_native_objects)
* [Looping and Comprehensions](#looping-and-comprehensions)
* [Extending Native Objects](#extending-native-objects)
* [Exceptions](#exceptions)
* [Annotations](#annotations)
* [Miscellaneous](#miscellaneous)

<a name="code_layout"/>
## Code layout

<a name="tabs_or_spaces"/>
### Tabs or Spaces?

Use **spaces only**, with **2 spaces** per indentation level. Never mix tabs and spaces.

<a name="maximum_line_length"/>
### Maximum Line Length

Limit all lines to a maximum of 79 characters.

<a name="blank_lines"/>
### Blank Lines

Separate top-level function and class definitions with a single blank line.
Expand All @@ -65,12 +61,10 @@ Separate method definitions inside of a class with a single blank line.

Use a single blank line within the bodies of methods or functions in cases where this improves readability (e.g., for the purpose of delineating logical sections).

<a name="trailing_whitespace"/>
### Trailing Whitespace

Do not include trailing whitespace on any lines.

<a name="optional_commas"/>
### Optional Commas

Avoid the use of commas before newlines when properties or elements of an Object or Array are listed on separate lines.
Expand All @@ -97,12 +91,10 @@ bar:
value: 87
```

<a name="encoding"/>
### Encoding

UTF-8 is the preferred source file encoding.

<a name="module_imports"/>
## Module Imports

If using a module system (CommonJS Modules, AMD, etc.), `require` statements should be placed on separate lines.
Expand All @@ -117,7 +109,6 @@ These statements should be grouped in the following order:
2. Third party library imports
3. Local imports _(imports specific to this application or library)_

<a name="whitespace"/>
## Whitespace in Expressions and Statements

Avoid extraneous whitespace in the following situations:
Expand Down Expand Up @@ -167,7 +158,6 @@ Additional recommendations:
fooBar = 3
```

<a name="comments"/>
## Comments

If modifying code that is described by an existing comment, update the comment such that it accurately reflects the new code. (Ideally, improve the code to obviate the need for the comment, and delete the comment entirely.)
Expand All @@ -176,7 +166,6 @@ The first word of the comment should be capitalized, unless the first word is an

If a comment is short, the period at the end can be omitted.

<a name="block_comments"/>
### Block Comments

Block comments apply to the block of code that follows them.
Expand All @@ -198,7 +187,6 @@ Paragraphs inside of block comments are separated by a line containing a single
stop()
```

<a name="inline_comments"/>
### Inline Comments

Inline comments are placed on the line immediately above the statement that they are describing. If the inline comment is sufficiently short, it can be placed on the same line as the statement (separated by a single space from the end of the statement).
Expand All @@ -221,7 +209,6 @@ However, inline comments can be useful in certain scenarios:
x = x + 1 # Compensate for border
```

<a name="naming_conventions"/>
## Naming Conventions

Use `camelCase` (with a leading lowercase character) to name all variables, methods, and object properties.
Expand All @@ -242,7 +229,6 @@ Methods and variables that are intended to be "private" should begin with a lead
_privateMethod: ->
```

<a name="functions"/>
## Functions

_(These guidelines also apply to the methods of a class.)_
Expand Down Expand Up @@ -312,7 +298,6 @@ In cases where method calls are being chained, some adopters of this style prefe

The function grouping style is not recommended. However, **if the function grouping style is adopted for a particular project, be consistent with its usage.**

<a name="strings"/>
## Strings

Use string interpolation instead of string concatenation:
Expand All @@ -324,7 +309,6 @@ Use string interpolation instead of string concatenation:

Prefer single quoted strings (`''`) instead of double quoted (`""`) strings, unless features like string interpolation are being used for the given string.

<a name="conditionals"/>
## Conditionals

Favor `unless` over `if` for negative conditions.
Expand Down Expand Up @@ -359,7 +343,6 @@ Multi-line if/else clauses should use indentation:
else ...
```

<a name="looping_and_comprehensions"/>
## Looping and Comprehensions

Take advantage of comprehensions whenever possible:
Expand Down Expand Up @@ -387,19 +370,16 @@ object = one: 1, two: 2
alert("#{key} = #{value}") for key, value of object
```

<a name="extending_native_objects"/>
## Extending Native Objects

Do not modify native objects.

For example, do not modify `Array.prototype` to introduce `Array#forEach`.

<a name="exceptions"/>
## Exceptions

Do not suppress exceptions.

<a name="annotations"/>
## Annotations

Use annotations when necessary to describe a specific action that must be taken against the indicated block of code.
Expand Down Expand Up @@ -432,7 +412,6 @@ Annotation types:

If a custom annotation is required, the annotation should be documented in the project's README.

<a name="miscellaneous"/>
## Miscellaneous

`and` is preferred over `&&`.
Expand Down Expand Up @@ -483,14 +462,14 @@ console.log args... # Yes
(a, b, c, rest...) -> # Yes
```

[coffeescript]: http://jashkenas.github.com/coffee-script/
[coffeescript-issue-425]: https://github.com/jashkenas/coffee-script/issues/425
[coffeescript]: https://github.com/jashkenas/coffeescript/
[coffeescript-issue-425]: https://github.com/jashkenas/coffeescript/issues/425
[spine-js]: http://spinejs.com/
[spine-js-code-review]: https://gist.github.com/1005723
[spine-js-code-review]: https://gist.github.com/jashkenas/1005723
[pep8]: http://www.python.org/dev/peps/pep-0008/
[ruby-style-guide]: https://github.com/bbatsov/ruby-style-guide
[google-js-styleguide]: http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml
[google-js-styleguide]: https://google.github.io/styleguide/jsguide.html
[common-coffeescript-idioms]: http://arcturo.github.com/library/coffeescript/04_idioms.html
[coffeescript-specific-style-guide]: http://awardwinningfjords.com/2011/05/13/coffeescript-specific-style-guide.html
[coffeescript-faq]: https://github.com/jashkenas/coffee-script/wiki/FAQ
[coffeescript-faq]: https://github.com/jashkenas/coffeescript/wiki/FAQ
[camel-case-variations]: http://en.wikipedia.org/wiki/CamelCase#Variations_and_synonyms