happy-git-with-r icon indicating copy to clipboard operation
happy-git-with-r copied to clipboard

Published 20 hours ago • verified publisher icon jennybc

CONTRIBUTING?

Open BarkleyBG opened this issue 8 years ago • 2 comments

Could you add a CONTRIBUTING.md document with guidelines on how to contribute to this project? It's an exciting endeavor!

BarkleyBG avatar Feb 03 '17 20:02 BarkleyBG

Good idea. Do you mean mechanics or philosophy or both? Also, have you seen one for a similar project that you find helpful?

jennybc avatar Feb 06 '17 21:02 jennybc

Both!

Philosophy

I'd like to know where you're looking for contributions, or where you're NOT looking for help. (Even if the guidelines simply say that anything is open to potential improvements)

Mechanics

  • I saw a good one (and I can't remember where) that said "file the issue before working on the PR - it may be that the issue has already been worked out or otherwise not open for improvements at this time". I can keep an eye out for that, but I can't remember where it was.
  • Microsoft's nodejstools has a good start for their contributing mechanisms.
  • David Robinson and Julia Silge's Tidy Text Mining uses a nice pro-inclusiveness template

BarkleyBG avatar Feb 06 '17 21:02 BarkleyBG