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

Added js guidelines #92

merged 3 commits into from
Jan 10, 2016

Conversation

RichardLitt
Copy link
Member

This should close #59

@jbenet jbenet added the status/in-progress In progress label Dec 27, 2015
- 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 ;)
Copy link
Member

Choose a reason for hiding this comment

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

let's not call it a fight, rather point it to issues where discussion is happening and invite folks to collaborate. We really shouldn't even have to lock on either, WebPack is mainly used by front end devs while browserify has a lot of users that are Node.js developers hacking on the browser.

Copy link
Member

Choose a reason for hiding this comment

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

I still suggest we put webpack here as the main choice as we are using that atm in all new projects. These are only guidelines no hard rules anyway.

Copy link
Member Author

Choose a reason for hiding this comment

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

So, confession: I'm a browserify person. I'm not going to suggest one over the other. @diasdavid is right about node devs. I'll remove the fight comment.

This should close #59
@RichardLitt
Copy link
Member Author

So, I changed it up a bit, and made two sections: one for contributors, and one for maintainers. This should make the entire thing easier. I think the three contributor suggestions are clear and make sense.

Sound good? cc @noffle @diasdavid @dignifiedquire

@dignifiedquire
Copy link
Member

Two more things

  1. Can we make all the tools links to their respective homepages
  2. We should add ghooks and pre-commit to the maintainers list

@RichardLitt
Copy link
Member Author

Added. All good?

@dignifiedquire
Copy link
Member

LGTM

RichardLitt added a commit that referenced this pull request Jan 10, 2016
@RichardLitt RichardLitt merged commit 9c9d49f into master Jan 10, 2016
@RichardLitt RichardLitt deleted the feature/js-guide branch January 10, 2016 20:31
@jbenet jbenet removed the status/in-progress In progress label Jan 10, 2016
- 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Node and Javascript guidelines file
5 participants