search

Khan / BabyHint

Provide more helpful hints for JavaScript developers.
9 stars 1 forks source link

Add a CONTRIBUTING.md #11

Open kevinbarabash opened 9 years ago

kevinbarabash commented 9 years ago
therebelrobot commented 9 years ago

nodejs/iojs.org has an excellent Contributing doc, as does io.js in general(That one is a lot more expansive, definitely more fine-tuned for a larger project)

Either of those would be great models for this repo. Including a code of conduct as well as relevant links to CLAs and coding styles is a good idea.

As for coding style in specific, I've been maintaining adherence to feross/standard in all of my npm modules, though I know it's not for everyone :stuck_out_tongue_winking_eye:

therebelrobot commented 9 years ago

Also, guidelines for commit messages would be smart too, make sure to reference issue numbers, etc.

kevinbarabash commented 9 years ago

I had a look at the CONTRIBUTING.md examples. I like that they included a workflow in the second one. I'll have to add that to live-editor as well.

The code already follows the KA style guide for JavaScript for the most part: https://github.com/Khan/style-guides/blob/master/style/javascript.md. It's kind of long so I'll include a quick summary and a link. Sorry that it's pretty much the complete oppose of feross/standard. In order to ease the burden maybe we can have an http://editorconfig.org/ file.

therebelrobot commented 9 years ago

So long as there's a .editorconfig I should be fine. When not employing an overarching program/formatter like standard, editorconfigs work splendidly.