3 ms·
Great read. My favorite part is this bullet point: > Use npm scripts so people don’t have to understand or globally install any build tools I do this on every
by BinaryIdiot 11y ago
Great read. My favorite part is this bullet point:
> Use npm scripts so people don’t have to understand or globally install any build tools
I do this on every project I work on. In fact, where possible, I completely skip globals entirely (for instance in my msngr.js library it uses Grunt but it executes grunt locally without it being installed globally on the machine).
I think it's really important that anyone can go up to a library, pull it down, and start it with little to no further effort. The less friction you can provide a developer the better.
- chowes 11y ago100% agree.. and just as important as ease of starting: ease of finishing. make all of your tests / linters / etc. runnable via a simple npm run. there's overhead in setting this up, but i can remember several times where i have pulled the code down, made my changes, and gave up when trying to figure out how the maintainer wants my code formatted / tested.
- peterjmag 11y agoAgreed! This saved us all kinds of headaches in a large project at my old company (not open source in this case, but still helpful). I left a similar response on Medium before I noticed your comment: https://medium.com/@peterjmag/great-tip-d6fcdec36e13 https://medium.com/@peterjmag/great-tip-d6fcdec36e13