vndb/mithril-vndb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Create CONTRIBUTING.md

Browse source 
I added the following to it:

- Bug reporting
- Feature requests
- Contributing guide
- Style guide
This commit is contained in:
Isiah Meadows 2015-11-07 06:34:11 -05:00 • committed by impinball
parent df114a4ee2
commit 9fab2b8371
18 changed files with 1209 additions and 352 deletions
Download patch file Download diff file Expand all files Collapse all files

856
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,856 @@
# Bug reports
Use the [issue tracker](https://github.com/lhorie/mithril.js/issues). Do check to make sure your bug hasn't already been filed. Please give the following information, where possible:
1. The version of Mithril you're using, whether it's the dev version or [the version on npm](http://npm.im/mithril.js). The version on npm may not have all the latest bug fixes, so your bug might very well be fixed in the dev version.
2. A detailed explanation of the bug.
3. A test case. The simpler, the better.
# Feature requests
Use the [issue tracker](https://github.com/lhorie/mithril.js/issues). Please do the following, where possible:
1. Check to make sure your suggestion hasn't already been filed. There's a nice collection of some of these feature requests [here](https://github.com/lhorie/mithril.js/issues/802).
2. Clearly denote your issue as a feature request. It helps make the intent clearer. Even better is to denote it in the title.
3. Describe your idea. This is the most important part.
4. Submit, and wait for feedback. Don't forget to drop by the [Gitter room](https://gitter.im/lhorie/mithril.js) to get some publicity. It gets traffic daily. :smile:
# Contributing
We welcome any and all contributions. This is a community-driven project. Although we don't have a lot, we do have a few guidelines for contributions.
1. Please adhere to the style guide. It's pretty lengthy, but most everything is checked by ESLint, and if anything fails to check, the build will fail, and you will know about it. Most of it is common practice and common sense. ESLint is also set up to check for other common errors, such as undeclared variables and invalid `typeof` values.
2. Please make sure there are no regressions with your patch. Please don't disable existing tests, and please don't send a PR with new, disabled tests.
- There are a few known failing tests currently (PRs welcome): [*](https://github.com/lhorie/mithril.js/blob/next/test/mithril.deferred.js#L121-L125) [*](https://github.com/lhorie/mithril.js/blob/next/test/mithril.render.js#L1321-L1343) [*](https://github.com/lhorie/mithril.js/blob/next/test/mithril.route.js#L106-L131) [*](https://github.com/lhorie/mithril.js/blob/next/test/mithril.route.js#L134-L162) [*](https://github.com/lhorie/mithril.js/blob/next/test/mithril.route.js#L165-L191) [*](https://github.com/lhorie/mithril.js/blob/next/test/mithril.route.js#L194-L222)
3. For any new features introduced, be sure to write new unit tests for it. Maximum coverage is what we want.
4. Try to not leave any extra `TODO`s, `FIXME`s, etc. in your code. ESLint will nag at you until you fix whatever problem it is.
- Note that it's only a warning, not an error. It won't fail the CI tests, and there's a few outstanding ones inside Mithril right now.
It is assumed that all contributions you make you have the appropriate rights to and that it may be made available under the MIT License, the license used for this project.
# Style Guide
The style is checked with ESLint. This style guide is here for one reason only: consistency. This should work for most code here, but this shouldn't be considered absolute &endash; consistency with the surrounding code is higher priority than following this guide. Also, if some sort of hack is impossible without violating this guide (e.g. if Mithril ever needs [Bluebird's infamous hack](https://stackoverflow.com/q/24987896)), just make sure the code is consistent with what's around it.
### Line length
Keep lines down to a maximum of 80 characters. Minifiers are very good at compressing whitespace, so don't be afraid to use it.
The only exception to this rule is with long regexes. Append `// eslint-disable-line max-len` to the end of those lines.
### Function length
Keep function length to no more than 20 statements, including those in nested blocks.
The only exceptions are for revealing module wrappers and Mocha `describe` and `context` blocks.
This isn't checked for the tests, but still, keep it reasonable.
### Line endings
Use Windows-style line endings (i.e. CRLF).
End each file with a line break.
### Semicolons
Avoid semicolons. (A few resources to help you understand this: [*](http://blog.izs.me/post/2353458699/an-open-letter-to-javascript-leaders-regarding) [*](http://inimino.org/~inimino/blog/javascript_semicolons) [*](http://jamesallardice.com/understanding-automatic-semi-colon-insertion-in-javascript/))
### Redundant expressions
Don't use redundant parentheses, curly braces, `undefined`s, labels, ternaries, etc. Examples:
- `var foo = value === 1 ? true : false` is better written as `var foo = value === 1`.
- `var foo = (value === 1) ? bar : baz` is better written as `var foo = value === 1 ? bar : baz`.
- `var foo = undefined` is better written as `var foo`.
- `return undefined` is better written as `return`.
- `delete(obj.foo)` is better written as `delete obj.foo`.
- `return` at the end of a function if you're returning `undefined` should just be omitted.
- If you're returning `null`, there's usually little reason to not just return `undefined`.
- Unused variables should be removed.
- An exception is detailed below for assignment in conditions.
### Equality testing
Use strict equality (`===`/`!==`), not loose equality (`==`/`!=`). The only exception is if you're testing for `null` or `undefined`, in which loose equality, `value == null` and `value != null` is preferred. The reason is for type safety with primitives.
### `eval` and friends
Never use `eval`, the `Function` constructor, and friends. Those will fail when running under CSP restrictions, and this library should work in those environments.
### Quotes
Prefer double quotes to single quotes, but using single quotes to avoid escaping is okay.
### Strict mode
All code must be in strict mode, preferably wrapped in an IIFE.
## Comments
Comments are helpful. Use descriptive comments where needed, so others can read it and understand it. If a non-obvious hack is used, explain it with a comment. But don't repeat yourself with a redundant comment when the code adequately describes itself.
```js
// Good, code is self-descriptive
var CARD_DECK_SIZE = 52
// Shuffle the deck of cards.
for (var i = 0; i < CARD_DECK_SIZE; i++) {
var j = i + (Math.random() * CARD_DECK_SIZE - i)|0
var tmp = deck[i]
deck[i] = deck[j]
deck[j] = tmp
}
// Also good, requires a descriptive comment.
function toFastProperties(obj) {
// Bluebird's toFastProperties hack. Forces V8 to optimize object as prototype,
// significantly speeding up property access.
/* eslint-disable no-eval */
function C() {}
C.prototype = obj
new C()
return
eval(obj)
/* eslint-enable no-eval */
}
// Bad, redundant comments
var CARD_DECK_SIZE = 52
// Shuffle the deck of cards.
function shuffle(deck) {
for (var i = 0; i < CARD_DECK_SIZE; i++) {
// Generate a random card index to swap at.
var j = i + (Math.random() * CARD_DECK_SIZE - i)|0
// Swap the cards at each index.
var tmp = deck[i]
deck[i] = deck[j]
deck[j] = tmp
}
}
```
### Magic values
Prefer constant variables to magic values where it helps with code readability. Also, don't use comments in place of a constant.
```js
// Good
var CARD_DECK_SIZE = 52
for (var i = 0; i < CARD_DECK_SIZE; i++) {
var j = i + (Math.random() * CARD_DECK_SIZE - i)|0
var tmp = a[i]
a[i] = a[j]
a[j] = tmp
}
// Bad, what's 52 for?
for (var i = 0; i < 52; i++) {
var j = i + (Math.random() * 52 - i)|0
var tmp = a[i]
a[i] = a[j]
a[j] = tmp
}
// Also bad, comment not substitute for constant
// 52 cards in a deck
for (var i = 0; i < 52; i++) {
var j = i + (Math.random() * 52 - i)|0
var tmp = a[i]
a[i] = a[j]
a[j] = tmp
}
```
### Distracting comments
Don't comment *everything*. It's distracting, pointless, and a waste of time. Only comment when you need to.
```js
// Extremely bad. Don't *ever* do this.
// This function loops through each item in a list, calling `f` with each item
// and their respective index. If the function `f` returns explicitly with
// `false`, iteration stops. This function returns the original list for
// convenience.
function forEach(list, f) {
// Loop through each entry in the list with the loop index `i`
for (var i = 0; i < list.length; i++) {
// Call the function with the current item and index
if (f(list[i], i) === false) {
// If the function explicitly returns `false`, immediately stop
// iteration.
break
}
}
// Return the list, for convenience.
return list
}
```
### Initial whitespace
Start your comments with a space. It's more readable.
```js
// Good
// This is a comment.
// Bad
//This is a comment.
```
### Grammar and spelling
Use proper grammar and spelling in your comments. This shouldn't need explanation.
## Whitespace
Use vertical whitespace and indentation to your advantage. It helps with readability, and minifiers are astonishingly great at removing this. :stuck_out_tongue_winking_eye:
```js
// Good
function iterate() {
var index = 0
var list = []
while (hasNext()) {
list.push(next(index))
index++
}
for (var i = 0; i < list.length; i++) {
read(list[i])
}
}
// Bad
function iterate() {
var index = 0
var list = []
while (hasNext()) list.push(next(index++))
for (var i = 0; i < list.length; i++) read(list[i])
}
// Even worse
function iterate() {
var list = []
for (var index = 0; hasNext(); list.push(next(index++))) {}
for (var i = 0; i < list.length; i++) read(list[i])
}
```
### Trailing whitespace
Please don't leave trailing spaces anywhere. It makes diffs harder to read.
### Indentation and vertical whitespace
Indent with hard tabs. Each one counts for 4 spaces.
Never mix tabs and spaces. Don't use smart tabs.
### Excessive whitespace
Keep whitespace within reason. Limit vertical whitespace to no more than 2 consecutive blank lines, and don't start or end blocks with plain whitespace. Don't use more than one character of horizontal whitespace beyond indentation.
```js
// Bad
function iterate() {
var index = 0
var list = []
while (hasNext()) {
list.push(next(index))
index++
}
// Too many empty lines
for (var i = 0; i < list.length; i++) {
read(list[i])
}
}
// Also bad
var a = 2
// ^^ ^^
```
### Control keywords
Always surround control keywords (e.g. `if`, `else`, `for`) with whitespace.
## Operators
### Binary operators
Always surround binary keyword operators (e.g. `in`, `instanceof`) with whitespace.
Always surround any other binary operator with whitespace, including assignment operators. Add line breaks after the operator, not before.
```js
// Good
var a = 1 + 2
a = 3
a += 4
var a = 1 + 2 + 3 + 4 + 5 +
6 + 7 + 8 + 9 + 10
// Bad
var a = 1+2
var a = 1 +2
var a = 1+ 2
var a=1+2
var a=1 + 2
a=3
a+=4
var a = 1 + 2 + 3 + 4 + 5
+ 6 + 7 + 8 + 9 + 10
```
As an exception, casting to a 32-bit integer (i.e. `x|0`) doesn't require whitespace surrounding it.
```js
// This is okay
var casted = value|0
```
### Unary operators
Always use whitespace between an unary keyword operator (e.g. `delete`, `new`) with whitespace.
Do not use spaces between any other unary operator and the value they apply to.
```js
// Good
!a
!!a
~~a
a++
++a
-1
~1
// Okay
+!a
// Bad
! a
!! a
! ! a
++ a
a ++
+ ! a
// Even worse
- 1
~ 1
```
Don't use `new function () {}`. Just use an object literal instead, and an IIFE if needed.
## Objects
### Exterior whitespace
Do not include space between the opening curly brace and the first object key in single line objects. For multi-line objects, don't include any extra preceding whitespace at the beginning or end.
```js
// Good
var object = {foo: 1}
var object = {
foo: 1,
bar: 2,
baz: 3,
quux: "string",
}
// Bad
var object = { foo: 1 }
var object = {
foo: 1,
bar: 2,
baz: 3,
quux: "string",
}
```
### Interior whitespace
Use no space before an object key and the colon, but use a single space between the colon and value.
```js
// Good
var object = {foo: 1}
// Bad
var object = {foo:1}
var object = {foo : 1}
// Very bad
var object = {foo :1}
```
### Larger objects
Non-trivial objects should occupy multiple lines.
```js
// Good
var object = {
foo: 1,
bar: 2,
baz: 3,
quux: "string",
}
// Bad
var object = {foo: 1, bar: 2, baz: 3, quux: "string"}
```
### Comma placement
Commas come last. Also, use trailing commas if the object takes multiple lines.
```js
// Good
var object = {
foo: 1,
bar: 2,
}
// Bad
var object = {
foo: 1,
bar: 2 // No trailing comma
}
var object = {
foo: 1
, bar: 2 // Comma first
}
// Trailing comma in single-line object
var object = {foo: 1,}
```
### Member access
When chaining methods and/or properties across multiple lines, dots come first.
```js
// Good
object
.foo()
.bar()
// Bad
object.
foo().
bar()
```
### Property quoting
Quote properties when needed. Never quote valid identifiers. This may lead to some inconsistency in whether properties are quoted or not in the object, but that inconsistency is okay, and is the only exception in consistency.
```js
// Good
var object = {
foo: 1,
bar: 2,
}
var object = {
foo: 1,
"non-identifier": 2,
}
// Bad
var object = {
"foo": 1,
"bar": 2,
}
var object = {
"foo": 1,
"non-identifier": 2,
}
```
### Iteration
When iterating objects with `for-in`, filter it with `Object.prototype.hasOwnProperty` first. This may be on the same line if that's the only condition. If this is used more than once, make a local `hasOwn` alias to use like `hasOwn.call(object, prop)`.
## Variables and declarations
Use camel case (e.g. `loopIndex`) for variables, pascal case (e.g. `MyClass`) for classes, and upper case with underscores (e.g. `MAX_VALUE`) for constants.
Use `self` to capture `this` where needed. (i.e. `var self = this`)
Prefer short but clear, descriptive, and self-documenting variable names.
Single letter names are only okay in these contexts:
- Loop variables: `i`, `j`, etc.
- Function arguments in small, trivial functional utilities: `f`, `g`, etc.
- Standard mathematical algorithms: `x`, `y`, `a`, `b`, etc.
```js
// Good
function forEach(list, f) {
for (var i = 0; i < list.length; i++) {
f(list[i], i)
}
return list
}
function ajax(url, callback) {
var xhr = new XMLHttpRequest()
xhr.open("GET", url)
xhr.onreadystatechange = function () {
if (this.readyState === 4) {
callback(this.responseText, this.status)
}
}
xhr.send()
}
// Bad
function iterateArray(listOfEntries, callback) {
for (var index = 0; index < listOfEntries.length; index++) {
callback(listOfEntries[index], index)
}
return listOfEntries
}
function getRequestStringFromServer(serverLocation, functionToCall) {
var xmlHttpRequest = new XMLHttpRequest()
xmlHttpRequest.open("GET", serverLocation)
xmlHttpRequest.onreadystatechange = function () {
if (this.readyState === 4) {
functionToCall(this.responseText, this.status)
}
}
xmlHttpRequest.send()
}
// Even worse
function e(l, c) {
for (var x = 0; x < l.length; x++) {
c(l[x], x)
}
return l
}
function a(u, f) {
var x = new XMLHttpRequest()
x.open("GET", url)
x.onreadystatechange = function () {
if (this.readyState === 4) {
f(this.responseText,this.status)
}
}
x.send()
}
```
### Multiple variable declarations
If a variable is assigned a value when it's declared, it gets its own line.
If a variable is not immediately assigned a value, it may be grouped with others that aren't first assigned values.
Do group related variables.
Variable declarations in the init block of a for loop are excluded from this rule, but the number of declarations should still be minimized.
```js
// Good
var a = 1
var b = 2
var c, d
// Also good
var foo, bar, baz, quux
var spam, eggs, ham
var shouldUpdate, initialize
// Okay, since it's within a for loop
for (var i = 0, test; (test = foo === 1); i++) {
doSomething(i)
}
// Bad
var a = 1, b = 2, c, d
// Even worse
var foo, bar, baz, quux, spam, eggs, ham, shouldUpdate, initialize
```
## Assignment
### Native functions
Don't assign to native functions or prototypes beyond polyfills. Ever.
### Function declarations
Don't assign to a function declaration. Declarations look like static values, so they should be treated that way. There is no difference in size, either.
```js
// Bad
function foo() { return 1 }
foo = function () { return 2 }
// Even worse
function foo() { return 1 }
foo = 2
```
### Conditions
Avoid assigning directly in conditions. If you need to assign in a condition, wrap them in a new set of parentheses.
```js
// Good
var test = foo === 1
if (test) {
doSomething()
}
var test = foo === 1
for (var i = 0; test; i++, test = foo === 1) {
doSomething(i)
}
if ((test = foo === 1)) {
doSomething()
}
for (var i = 0, test; (test = foo === 1); i++) {
doSomething(i)
}
// Bad
if (test = foo === 1) {
doSomething()
}
for (var i = 0, test; test = foo === 1; i++) {
doSomething(i)
}
```
## Functions
Prefer anonymous functions to named functions in expressions where possible
Prefer named function declarations to assigning a function to a declared variable where possible.
```js
// Good
setTimeout(function () { doSomething() }, 0)
function foo() {
return 1
}
// Good, uses recursion
setTimeout(function f() {
doSomething()
if (shouldRepeat()) setTimeout(f, 0)
}, 0)
// Bad
requestAnimationFrame(function foo() { runNext() })
var foo = function () {
return 1
}
```
### Anonymous functions
Anonymous functions must have a single space between `function` and the arguments and between the arguments and the opening brace.
### Named functions, function declarations
Named functions and function declarations must have no space between the function name and the arguments and a single space between the arguments and the opening brace.
## Blocks and conditionals
### Curly braces
Curly braces are required for blocks if the body takes up more than one line. This goes for functions as well. They are optional if it fits within one line, but don't be afraid to use them where you see fit.
Do put an extra space after the first brace and before the final brace in single-line functions.
```js
// Good
if (condition) doSomething()
if (condition) {
doSomething()
}
if (condition) {
doSomething()
} else {
doSomethingElse()
}
if (condition) {
doSomething()
doSomethingElse()
}
setTimeout(function () { doSomething() }, 0)
setTimeout(function () {
doSomething()
}, 0)
// Bad
if (condition) { doSomething(); doSomethingElse() }
if (condition)
doSomething()
setTimeout(function () { doSomething(); doSomethingElse() }, 0)
setTimeout(function () {doSomething()}, 0) // Body needs some space
```
### Function declarations
Function declarations should always take more than one line.
```js
// Good
function foo() {
return bar
}
// Bad
function foo() { return bar }
```
### `if`-`else`
Be consistent with braces in `if`-`else` statements.
```js
// Good
if (condition) doSomething()
else doSomethingElse()
if (condition) {
doSomething()
} else {
doSomethingElse()
}
if (condition) {
doSomething()
} else if (anotherCondition) {
doSomethingElse()
} else {
doAnotherThing()
}
// Okay
if (condition) doSomething()
else if (anotherCondition) doSomethingElse()
else doAnotherThing()
// Bad
if (condition) doSomething()
else {
doSomethingElse()
}
if (condition) doSomething()
else if (anotherCondition) {
doSomethingElse()
} else doAnotherThing()
if (condition) {
doSomething()
} else doSomethingElse()
```
### Empty blocks
Mark empty blocks as intentionally empty via a comment or similar. Don't just leave an empty block and/or semicolon.
```js
// Good
for (var i = 0; i < list.length && cond(list[i]); i++) {
// empty
}
// Bad
for (var i = 0; i < list.length && cond(list[i]); i++) {}
// Also bad
for (var i = 0; i < list.length && cond(list[i]); i++) {
;
}
// Even worse
for (var i = 0; i < list.length && cond(list[i]); i++);
```
### Nesting
Don't nest `if` statements in `else` blocks if you don't need to.
```js
// Good
if (test) {
doSomething()
} else if (otherTest) {
doSomethingElse()
}
if (test) {
doSomething()
} else {
if (otherTest) {
doSomethingElse()
}
doThisOtherThing()
}
// Bad
if (test) {
doSomething()
} else {
if (otherTest) {
doSomethingElse()
}
}
```
Don't nest curly braces beyond 4 levels deep. This includes blocks, loops, and functions, as well as IIFE wrappers. This also includes the tests. There's rarely a reason to go farther, as most of the time, it's a signal to refactor and/or re-organize your code.
### Brace style
Put the `else`, `catch`, and `finally` on the same line as its closing brace.
(Obviously, this doesn't apply to `if`-`else` statements that don't use curly braces.)