-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d0ea56e
commit bcca0c7
Showing
238 changed files
with
119,415 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
doc/**/*.js | ||
doc/*.js | ||
node_modules/**/*.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
{ | ||
"env": { | ||
"node": true, | ||
"es6": true | ||
}, | ||
"globals": {}, | ||
"rules": { | ||
"no-bitwise": 0, | ||
"camelcase": 0, | ||
"curly": 2, | ||
"eqeqeq": 2, | ||
"no-extend-native": 2, | ||
"wrap-iife": [ | ||
2, | ||
"any" | ||
], | ||
"indent": [ | ||
2, | ||
2, | ||
{ | ||
"SwitchCase": 1 | ||
} | ||
], | ||
"no-use-before-define": [ | ||
2, | ||
{ | ||
"functions": false | ||
} | ||
], | ||
"new-cap": 0, | ||
"no-caller": 2, | ||
"no-empty": 2, | ||
"no-new": 2, | ||
"quotes": [ | ||
2, | ||
"single" | ||
], | ||
"strict": [ | ||
2, | ||
"global" | ||
], | ||
"no-undef": 2, | ||
"no-unused-vars": 2, | ||
"max-params": [ | ||
2, | ||
4 | ||
], | ||
"max-statements": [ | ||
2, | ||
14 | ||
], | ||
"complexity": [ | ||
2, | ||
6 | ||
], | ||
"max-depth": [ | ||
2, | ||
3 | ||
], | ||
"max-len": [ | ||
2, | ||
{ | ||
"code": 80, | ||
"ignoreComments": true | ||
} | ||
], | ||
"no-multi-str": 2, | ||
"keyword-spacing": [2, { | ||
"after": true, | ||
"before": true, | ||
"overrides": { | ||
"function": { | ||
"after": false | ||
} | ||
} | ||
}], | ||
"space-before-function-paren": [2, "never"], | ||
"brace-style": [2, "1tbs"] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
|
||
# Runtime data | ||
pids | ||
*.pid | ||
*.seed | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
lib-cov | ||
|
||
# Coverage directory used by tools like istanbul | ||
coverage | ||
|
||
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) | ||
.grunt | ||
|
||
# node-waf configuration | ||
.lock-wscript | ||
|
||
# Compiled binary addons (http://nodejs.org/api/addons.html) | ||
build/Release | ||
|
||
# Dependency directory | ||
node_modules | ||
|
||
# Optional npm cache directory | ||
.npm | ||
|
||
# Optional REPL history | ||
.node_repl_history | ||
|
||
# Ignore compiled docs, but leave the directory | ||
jsdoc | ||
|
||
# Ignore swp files from the beloved vim | ||
*.swp | ||
|
||
# Ignore browser build, but leave the directory | ||
dist/** | ||
!dist/.gitkeep |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
{ | ||
"opts": { | ||
}, | ||
"templates": { | ||
"systemName": "Storj Core", | ||
"copyright": "Copyright 2016 Storj Labs", | ||
"includeDate": false, | ||
"navType": "vertical", | ||
"logoFile": "img/logo.svg", | ||
"theme": "storj", | ||
"linenums": false, | ||
"collapseSymbols": false, | ||
"inverseNav": false, | ||
"outputSourceFiles": true, | ||
"outputSourcePath": true, | ||
"dateFormat": "", | ||
"sort": "longname", | ||
"syntaxTheme": "default" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
{ | ||
"bitwise": false, | ||
"browser": true, | ||
"camelcase": false, | ||
"curly": true, | ||
"devel": false, | ||
"eqeqeq": true, | ||
"esnext": true, | ||
"freeze": true, | ||
"immed": true, | ||
"indent": 2, | ||
"latedef": true, | ||
"newcap": false, | ||
"noarg": true, | ||
"node": true, | ||
"noempty": true, | ||
"nonew": true, | ||
"quotmark": "single", | ||
"regexp": true, | ||
"smarttabs": false, | ||
"strict": true, | ||
"trailing": true, | ||
"undef": true, | ||
"unused": true, | ||
"maxparams": 4, | ||
"maxstatements": 14, | ||
"maxcomplexity": 6, | ||
"maxdepth": 3, | ||
"maxlen": 80, | ||
"multistr": true, | ||
"predef": [ | ||
"after", | ||
"afterEach", | ||
"before", | ||
"beforeEach", | ||
"describe", | ||
"exports", | ||
"it", | ||
"module", | ||
"require" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
6.9.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
language: node_js | ||
compiler: | ||
- gcc | ||
- clang | ||
addons: | ||
apt: | ||
sources: | ||
- ubuntu-toolchain-r-test | ||
packages: | ||
- gcc-4.8 | ||
- g++-4.8 | ||
- clang | ||
node_js: | ||
- "6.9.1" | ||
before_install: | ||
- export CXX="g++-4.8" CC="gcc-4.8" | ||
after_script: | ||
- npm run coverage | ||
- cat ./coverage/lcov.info | ./node_modules/.bin/coveralls |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
Contributing | ||
============ | ||
|
||
Want to contribute, but not sure where to start? Check out our [issue | ||
board](http://waffle.io/storj/core)! | ||
|
||
This document outlines general patterns and conventions for contributing | ||
to the project. For in-depth documentation on StorjCORE, [read the | ||
documentation](http://storj.github.io/core). | ||
|
||
Contributor License Agreement | ||
----------------------------- | ||
|
||
By submitting pull requests, you agree that your work may be licensed under | ||
one of: | ||
|
||
* GNU Affero General Public License Version 3 (or later) | ||
* GNU Lesser General Public License Version 3 (or later) | ||
|
||
You also assert that you have completed the | ||
[Contributor License Agreement](https://storj.io/cla) | ||
|
||
Reporting Issues | ||
---------------- | ||
|
||
When submitting an issue, please take care to follow the | ||
`ISSUE_TEMPLATE.md` and include as much information as possible. Bonus points | ||
for a corresponding pull request that fixes the issue. | ||
|
||
Pull Requests for Swag | ||
---------------------- | ||
We love pull requests, so to encourage more of them we are offering | ||
awesome swag. Only SIGNIFICANT pull requests count. Fixing a comma | ||
doesn’t count, but fixing a bug, adding more test coverage, or writing | ||
guides & documentation does. | ||
|
||
- Make 1x pull requests to get into the contributors list and website | ||
- Make 2x pull requests, we will send you a packet of stickers | ||
- Make 5x pull requests, and we will send you a t-shirt and more stickers | ||
- Make 10x pull requests, and you get a job interview with James + other swag | ||
|
||
If we miss a milestones (probably because we are working hard), just let | ||
us know so we can get you your swag. | ||
|
||
Style & Conventions | ||
------------------- | ||
|
||
### Style Guide | ||
|
||
StorjCORE adheres to | ||
[Felix's Node.js Style Guide](https://github.com/felixge/node-style-guide). | ||
Please take the time to review the style guide and take care to follow it. | ||
|
||
### Project Structure | ||
|
||
* `bin/` - Command line utilities linked during global installation | ||
* `dist/` - Placeholder for browser bundles generated with `npm run build` | ||
* `doc/` - Markdown documentation on various topics not covered by JSDoc | ||
* `lib/` - All core classes and modules | ||
* `script/` - Miscellaneous scripts and utilities used for development | ||
* `test/` - Unit and integration tests for core classes and modules | ||
|
||
### Inline Documentation | ||
|
||
You should also make the best use of [JSDoc](http://usejsdoc.org/) comments as | ||
shown throughout the source code. These annotation are used to generate the | ||
library's documentation website. Please be as descriptive as possible and take | ||
care to familiarize yourself with all of the possible JSDoc tags for | ||
being as thorough as possible. | ||
|
||
Test Coverage | ||
------------- | ||
|
||
Pull requests submitted without additional test coverage are unlikely to be | ||
merged. Pull requests that decrease test coverage will be rejected. If your | ||
submission fixes a bug that was not previously caught with the test suite, then | ||
please add an additional test that does cover it. | ||
|
||
You can run the coverage report with: | ||
|
||
``` | ||
npm run coverage | ||
``` | ||
|
||
Linting | ||
------- | ||
|
||
To help maintain consistent expectations for code quality and enforcing these | ||
conventions, there is an included `.jshintrc` file. Most editors support using | ||
this to alert you of offending code in real time but, if your editor does not, | ||
you can run the linter with: | ||
|
||
``` | ||
npm run linter | ||
``` | ||
|
||
Alternatively, the linter will run as part of the test suite as well, which can | ||
be executed with: | ||
|
||
``` | ||
npm test | ||
``` | ||
|
||
Credits | ||
------- | ||
|
||
Before sending your PR, go ahead and add yourself to the `contributors` array | ||
in the `package.json` file - you earned it :thumbsup:. | ||
|
||
![HACK THE PLANET](http://i.giphy.com/X1OGEvUf2t58A.gif) | ||
|
||
--- | ||
|
||
Have fun and be excellent! |
Oops, something went wrong.