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

Contributor Guide #1

Open
christiansmith opened this issue Aug 10, 2017 · 1 comment
Open

Contributor Guide #1

christiansmith opened this issue Aug 10, 2017 · 1 comment

Comments

@christiansmith
Copy link
Member

We need to codify our standard development practices and publish for use across all repositories in the org. At a bare minimum, we need to expand on the Contribute section used in our README files, and create a standard CONTRIBUTE.md file. Bonus points for a human friendly contributor guide.

Please post ideas and topics here for review and group discussion.

@EternalDeiwos
Copy link
Member

Shameless plagiarism from the issues I opened on other repos:

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.

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

No branches or pull requests

2 participants