search

workshopper / how-to-npm

A module to teach you how to module.
https://www.npmjs.com/package/how-to-npm
ISC License
1.11k stars 219 forks source link

Reduce contribution friction #67

Closed bengl closed 8 years ago

bengl commented 8 years ago

These are a few steps to hopefully reduce friction in contributions.

  1. Use standard. There are a bunch of PRs already lying around that don't fit the existing style of the code in the file. Hopefully this will reduce the chances of that happening in the future. The existing files were already almost in line with standard, so I went with that and fixed 'em all up.
  2. Issue/PR templates. Hopefully reduces duplicate issues, and hopefully enforces the usage of standard. Happy to change the wording.

/cc @ashleygwilliams

EmmaRamirez commented 8 years ago

Thank you!

I definitely agree that we should ensure that we should enforce/ensure the usage of standard.

I think two options are just linking to the standard/npm style guide in an issue template or README, but there is also the possibility of including the standard linter itself, alongside asking the contributor to make sure tests are passing.

bengl commented 8 years ago

Yep, standard is included in this PR.

Sadly, there are currently no tests. The test script in this PR is just standard.

EmmaRamirez commented 8 years ago

LGTM, merging!