Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added js guidelines #92

Merged
merged 3 commits into from
Jan 10, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
19 changes: 19 additions & 0 deletions js-contribution-guidelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# JS Contribution Guidelines

Many IPFS projects use JavaScript. Please check these guidelines before contributing JavaScript code to an IPFS repository.

## Contributing

- Follow conventions in that repo.
- Lint your code. Check whether [standard](//github.com/feross/standard) or [eslint](https://github.com/eslint/eslint) is being used.
- Run any relevant precommit scripts or tests that are in the package.json.

## Suggestions For Maintainers

- Build system: Use `npm run` for small projects; for larger ones, use [gulp](http://gulpjs.com/).
- Testing node: [mocha](https://mochajs.org/)
- Testing browser: [karma](https://karma-runner.github.io/0.13/index.html) and [mocha](https://mochajs.org/)
- Browser building: [webpack](https://webpack.github.io/) or [browserify](http://browserify.org/).
- Linting: Use [standard](//github.com/feross/standard). If you have to configure styles at the repo level because you or we are using Babel and ES6, use [eslint](https://github.com/eslint/eslint), [eslint-config-standard](https://github.com/feross/eslint-config-standard), and [babel-eslint](https://github.com/babel/babel-eslint) as needed. (If you're not sure, use standard).
- Use [greenkeeper](http://greenkeeper.io/) to keep your deps up to date.
- Use [precommit](https://www.npmjs.com/package/pre-commit) and [ghooks](https://www.npmjs.com/package/ghooks) to run tests while developing.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we use ghooks for any project?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not yet 😈

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's just a recommendation. You don't have to use it.