Skip to content

Commit

Permalink
Added js guidelines
Browse files Browse the repository at this point in the history
This should close #59
  • Loading branch information
RichardLitt committed Dec 27, 2015
1 parent 211856f commit 6f414fc
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
8 changes: 7 additions & 1 deletion contribution-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,13 @@ If your pull request is not accepted on the first try, don't be discouraged! If

Each repository will have its own code and test conventions. Please make sure to review those before jumping in. Some general conventions are listed below.

If you are contributing to a repository written in Go, please look at the [Go Contribution Guidelines](go-contribution-guidelines.md).
### Go

Please look at the [Go Contribution Guidelines](go-contribution-guidelines.md).

### JavaScript

Please look at the [JS Contribution Guidelines](js-contribution-guidelines.md).

### Git

Expand Down
12 changes: 12 additions & 0 deletions js-contribution-guidelines.md
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.

0 comments on commit 6f414fc

Please sign in to comment.