search

anvilresearch / webcrypto

W3C Web Cryptography API for Node.js
MIT License
82 stars 14 forks source link

Standard README and Style Guide #42

Open EternalDeiwos opened 7 years ago

EternalDeiwos commented 7 years ago

To maintain a standard style across our repositories and to aid new contributors, I propose that we add EditorConfig files to our repositories and make a note of it in our READMEs.

Most editors (vim, Sublime, Atom, VSCode, etc.) have plugins for EditorConfig making it relatively easy to automate tab indentation size, UNIX line-endings and ensure that files end with a new line.

Please see the @trust/model README and .editorconfig file for the proposed configuration.

dmitrizagidulin commented 7 years ago

I would like to propose that we go one step farther, and actually adopt (ferross's) JS Standard styleguide (and tie it into the 'npm test' script) - a fairly common practice among projects of this size.

christiansmith commented 7 years ago

We use feross' Standard JavaScript in many other anvil repos, just haven't gotten around to adding it to these new ones. Would you mind filing an issue for this in trustdata/org just so we can keep all the discussion of this nature in one place? Thanks.