SlideShare uses cookies to improve functionality and performance, and to provide you with relevant advertising. If you continue browsing the site, you agree to the use of cookies on this website. See our User Agreement and Privacy Policy.
SlideShare uses cookies to improve functionality and performance, and to provide you with relevant advertising. If you continue browsing the site, you agree to the use of cookies on this website. See our Privacy Policy and User Agreement for details.
Successfully reported this slideshow.
Activate your 14 day free trial to unlock unlimited reading.
What makes a good open source contributing guide? Highlights and best practices from research. From an Open Source Show and Tell talk in San Francisco, April 22 2016.
Template referenced in the talk can be found here: https://github.com/nayafia/contributing-template
FOOTNOTES
Slides 3 and 4: Based on GitHub Search conducted Apr 18 2016. Thanks Brandon Keepers (@bkeepers) for helping with this!
Slides 5 and 6: https://peerj.com/preprints/1233.pdf
Slides 7 and 8: Current as of Apr 18 2016
Slide 20: http://read-the-docs.readthedocs.org/en/latest/contribute.html
Slide 21: https://github.com/plataformatec/devise/wiki/Contributing
Slide 22: https://docs.djangoproject.com/en/dev/internals/contributing/new-contributors/#guidelines
Slide 23: https://github.com/angular/material/blob/master/CONTRIBUTING.md#-git-commit-guidelines
Slide 24: https://github.com/celery/celery/blob/master/CONTRIBUTING.rst#security
What makes a good open source contributing guide? Highlights and best practices from research. From an Open Source Show and Tell talk in San Francisco, April 22 2016.
Template referenced in the talk can be found here: https://github.com/nayafia/contributing-template
FOOTNOTES
Slides 3 and 4: Based on GitHub Search conducted Apr 18 2016. Thanks Brandon Keepers (@bkeepers) for helping with this!
Slides 5 and 6: https://peerj.com/preprints/1233.pdf
Slides 7 and 8: Current as of Apr 18 2016
Slide 20: http://read-the-docs.readthedocs.org/en/latest/contribute.html
Slide 21: https://github.com/plataformatec/devise/wiki/Contributing
Slide 22: https://docs.djangoproject.com/en/dev/internals/contributing/new-contributors/#guidelines
Slide 23: https://github.com/angular/material/blob/master/CONTRIBUTING.md#-git-commit-guidelines
Slide 24: https://github.com/celery/celery/blob/master/CONTRIBUTING.rst#security
11.
@nayafia
Why should you
care about
contributing guides?
12.
@nayafia
Contributing guides
help clarify your
commitment
13.
@nayafia
Contributing guides
help your project
grow
14.
@nayafia
Contributing guides
mean you have to do
less work
15.
@nayafia
What do good
contributing guides
look like?
16.
@nayafia
Looked at 40
projects: ½ on small
side, ¼ medium, ¼
large**
** this is totally handwavy gutfeel stuff based on what I vaguely know
about who’s contributing to and using these projects. plz forgive
17.
@nayafia
Good guides cover
basically the same
things, regardless of
size
18.
@nayafia
I’ll spare you the
boring stuff. Go here:
https://github.
com/nayafia/contributing-
template
21.
@nayafia
Ask for the
contributions you want
Tell them what you are or aren’t looking for, ask for help on known issues, etc.
22.
@nayafia
Create a “Your First
Contribution” section
23.
@nayafia
Use templates and
label conventions
Standardized stuff makes your life easier.
24.
@nayafia
Explain security
disclosures
At bare minimum, let them know that if they find a security issue, they
should contact you privately, and tell them how to reach you.