Skip to content

Commit 94fd4fe

Browse files
committed
3.0docs
1 parent 4459629 commit 94fd4fe

File tree

126 files changed

+10200
-5142
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

126 files changed

+10200
-5142
lines changed

API.md

Lines changed: 1 addition & 2796 deletions
Large diffs are not rendered by default.

CONTRIBUTING.md

Lines changed: 1 addition & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1 @@
1-
#READ BEFORE CREATING A NEW ISSUE
2-
3-
The issue tracker is for bug reports and feature requests. If you'd like help with a usage question please use [the [bluebird] tag in Stack Overflow](http://stackoverflow.com/tags/bluebird) and ask there. The tag is monitored regularly. You may also discuss things that are out of scope for the issue tracker on the [mailing list](https://groups.google.com/forum/#!forum/bluebird-js).
4-
5-
6-
# Contributing to bluebird
7-
8-
1. [Directory structure](#directory-structure)
9-
2. [Style guide](#style-guide)
10-
3. [Testing](#testing)
11-
12-
## Directory structure
13-
14-
- `/benchmark` contains benchmark scripts and stats of benchmarks
15-
16-
- `/tools` contains building and testing tools and scripts
17-
18-
- `/src` contains the source code
19-
20-
- `/test` contains test code
21-
22-
- `/test/mocha` contains tests using the mocha testing framework
23-
- `/test/browser` a directory that can be statically served using a webserver to run tests in browsers. See [testing in browsers](README.md#testing-in-browsers).
24-
25-
26-
## Style guide
27-
28-
Use the same style as is used in the surrounding code.
29-
30-
###Whitespace
31-
32-
- No more than 80 columns per line
33-
- 4 space indentation
34-
- No trailing whitespace
35-
- LF at end of files
36-
- Curly braces can be left out of single statement `if/else/else if`s when it is obvious there will never be multiple statements such as null check at the top of a function for an early return.
37-
- Add an additional new line between logical sections of code.
38-
39-
###Variables
40-
41-
- Use multiple `var` statements instead of a single one with comma separator. Do not declare variables until you need them.
42-
43-
###Equality and type checks
44-
45-
- Always use `===` except when checking for null or undefined. To check for null or undefined, use `x == null`.
46-
- For checks that can be done with `typeof`: do not make helper functions, save results of `typeof` to a variable or make the type string a non-constant. Always write the check in the form `typeof expression === "constant string"` even if it feels like repeating yourself.
47-
48-
## Testing
49-
50-
Make sure that all the tests run before and after you make your additions. Look in the [testing section in README.md](https://github.com/petkaantonov/bluebird#testing) for how to run the tests. Add relevant new tests.
51-
1+
[http://bluebirdjs.com/docs/contribute.html](http://bluebirdjs.com/docs/contribute.html)

0 commit comments

Comments
 (0)