Git Product home page Git Product logo

Comments (4)

therebelrobot avatar therebelrobot commented on June 15, 2024

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 😜

from babyhint.

therebelrobot avatar therebelrobot commented on June 15, 2024

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

from babyhint.

kevinbarabash avatar kevinbarabash commented on June 15, 2024

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.

from babyhint.

therebelrobot avatar therebelrobot commented on June 15, 2024

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

from babyhint.

Related Issues (15)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.