Skip to content

Commit 03fb723

Browse files
committed
introduction: include notes about contributions
1 parent f8eccd4 commit 03fb723

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1-
# CoffeeScript style guide
1+
# CoffeeScript Style Guide
2+
3+
This guide presents a collection of best-practices and coding conventions for the [CoffeeScript][coffeescript] programming language.
4+
5+
This guide is intended to be community-driven, and contributions are highly encouraged.
6+
7+
Please note that this is a work-in-progress: there is much more that can be specified, and some of the guidelines that have been specified may not be deemed to be idiomatic by the community (in which case, these offending guidelines will be modified or removed, as appropriate).
28

3-
[CoffeeScript](http://jashkenas.github.com/coffee-script/) is the main client-side language used to write code for Polar Mobile. This style guide is a list of coding conventions to be followed when writing CoffeeScript code.
49
## Inspiration
510

611
The details in this guide have been very heavily inspired by several existing style guides and other resources. In particular:

0 commit comments

Comments
 (0)