-
Notifications
You must be signed in to change notification settings - Fork 226
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
2 changed files
with
19 additions
and
1 deletion.
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
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,12 @@ | ||
# JS Contribution Guidelines | ||
|
||
Many IPFS projects use javascript. Please check these guidelines before contributing js code to an IPFS repository. | ||
|
||
## Suggestions | ||
|
||
- Build system: Use `npm run` for small projects; for larger ones, use `gulp`. | ||
- Testing node: `mocha` | ||
- Testing browser: `karma` + `mocha` | ||
- Browser building: `webpack` or `browserify` (this fight is still ongoing ;) | ||
- Linting: `eslint` + `eslint-config-standard`. This is roughly the same as [feross/standard](//github.com/feross/standard), but is easier to integrate and customize if needed. | ||
- Use [greenkeeper](http://greenkeeper.io/) to keep your deps up to date. |