Skip to content
This repository has been archived by the owner on Feb 25, 2019. It is now read-only.

Standard README and Style Guide #42

Open
EternalDeiwos opened this issue Aug 10, 2017 · 2 comments
Open

Standard README and Style Guide #42

EternalDeiwos opened this issue Aug 10, 2017 · 2 comments
Milestone

Comments

@EternalDeiwos
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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.

@EternalDeiwos EternalDeiwos added this to the v1.0.0 milestone May 20, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants