Downloaded 27 times
Uploaded byAndy Lester
Community and Github: 7/27/2011
This document provides tips for using GitHub effectively to share projects and build developer communities. It recommends making a project site to provide essential information for new users, releasing projects regularly to affirm they can be used and allow others to build upon the work, and maintaining an open and helpful approach to contributions from newcomers to encourage participation and learning. The focus should be optimizing for users rather than just developers. GitHub projects have a low barrier to entry, so guidance and dividing work into approachable chunks is important to welcome new contributors.
More Related Content
Similar to Community and Github: 7/27/2011
![UiPath Automation Suite Installation (Hands-On) [2/3]](https://cdn.slidesharecdn.com/ss_thumbnails/automationsuitecommunitysession2-251015095633-a6d862f1-thumbnail.jpg?width=600ounds&width=560&fit=bounds)
Community and Github: 7/27/2011
- 1. Andy Lester @petdance Projects, Community and Github
- 2. What we’ll cover •Presenting your project to the world • Managing the development process • Side trip to diversity • Your experiences
- 3. Why to stay •Perspectives on community & you! • Adorable Octocat art! • Tips for patch management! • Star Trek references! • Release management! • Sweaty Steve Ballmer!
- 4. Who is Githubfor?
- 5.
- 6. Github is not forend users.
- 7.
- 10. Github is forthose who like to build from source.
- 13.
- 15. To the newcomer, the source tree is unimportant.
- 16. To the newcomer, the source tree is unimportant.
- 17. Just because we’ve publishedcode doesn’t mean we’re done.
- 18. What's it do? What'sit look like? Do I want to use it?
- 19. That means: Screenshots and installation
- 20. Make a projectsite!
- 21. Make a projectsite.
- 22. Make a projectsite.
- 23. Make a projectsite. • Answer the newcomer's questions. • Aimed toward the end users. • Users who are not as ninja as you. • Make download + install incredibly obvious. • It can be on github, but not the default github project page.
- 24. Get your owndomain. • Not tied to github, in case things change. • $10/year = dirt-cheap investment • Which is easier to remember? • http://github.com/petdance/ack • http://betterthangrep.com/
- 25. Visible, documented releases matter!
- 26.
- 27.
- 28. Release for simplicity •Releases are an affirmation: "Yes, you can use this."
- 29. Release for simplicity •Releases are an affirmation: "Yes, you can use this." • Single, verifiable tarball.
- 30. Release for simplicity •Releases are an affirmation: "Yes, you can use this." • Single, verifiable tarball. • Nobody wants to run autoconf.
- 31. Release for simplicity •Releases are an affirmation: "Yes, you can use this." • Single, verifiable tarball. • Nobody wants to run autoconf. • Users expect them.
- 32. Release for history and visibility
- 33. Release for history and visibility • Lets others build on your work.
- 34. Release for history and visibility • Lets others build on your work. • Maintain an accurate, human-written changelog of all releases.
- 35. Release for history and visibility • Lets others build on your work. • Maintain an accurate, human-written changelog of all releases. • A dump of commit messages is not a changelog!
- 36. Optimize for your users' sake, not your own.
- 37. The needs ofthe many outweigh the needs of the few, or the one.
- 38. The needs ofthe users outweigh the needs of the project team.
- 40.
- 41. About @petdance • Perlguy: ack, prove, WWW::Mechanize • Programming for money since the 1980s • I sling PHP for B2B web apps for a midsize corporation. • From the midwest, Chicago area
- 43. A little bitabout ack
- 44. Github projects havea low barrier to entry.
- 45. The good part: Anyonecan do it.
- 46. The bad part: Anyonecan do it.
- 47. Newbies expect their changesto be accepted.
- 48.
- 49. Be gentle inyour rejections. Brevity may be perceived as harsh.
- 50. That box istoo small.
- 51. You want toaccept changes from newbies if at all possible.
- 52. Don't reject patches just because of... • No tests • No documentation • Not following code standards • Those can all be fixed!
- 53. The other dayI got this in the mail...
- 55. I am happyto suggest use cases that I have found useful. What is the best way - to mailing list, on a wiki somewhere, email to you. Don't quite feel up to being more proactive. I am dyslexic and find writing stuff hard (and finishing of writing etc).
- 56. Make a projectguide
- 57. Make a projectguide • Small chunks of the elephant
- 58. Make a projectguide • Small chunks of the elephant • "TODO: Better error handling" is not helpful to the newbie.
- 59. Make a projectguide • Small chunks of the elephant • "TODO: Better error handling" is not helpful to the newbie. • Project direction
- 60. Make a projectguide • Small chunks of the elephant • "TODO: Better error handling" is not helpful to the newbie. • Project direction • Coding standards
- 61. Make a projectguide • Small chunks of the elephant • "TODO: Better error handling" is not helpful to the newbie. • Project direction • Coding standards • Workflow + branch strategy
- 62.
- 64. Thank you • Putyourself in the newbie's shoes. • Make a project home page outside Github. • Visible, documented releases matter. • Optimize for others, not yourself. • Use Github to encourage your community, not fend it off. • Thank you for listening and for Githubbing.
Editor's Notes
- #2 \n
- #3 \n
- #4 \n
- #5 \n
- #6 \n
- #7 \n
- #8 Nat has 171,000 readers at radar.oreilly.com\n
- #9 Somebody clicks the link and wants to download it, and what they're presented with is a dev-oriented home page.\n
- #10 The download link isn't very descriptive.\n
- #11 \n
- #12 \n
- #13 \n
- #14 \n
- #15 \n
- #16 \n
- #17 Somebody clicks the link and wants to download it, and what they're presented with is a dev-oriented home page.\n
- #18 \n
- #19 \n
- #20 \n
- #21 \n
- #22 \n
- #23 \n
- #24 \n
- #25 \n
- #26 \n
- #27 \n
- #28 \n
- #29 \n
- #30 \n
- #31 \n
- #32 \n
- #33 \n
- #34 \n
- #35 \n
- #36 \n
- #37 \n
- #38 \n
- #39 \n
- #40 \n
- #41 "Dad, if you don't get it, it's because I didn't do it."\n
- #42 \n
- #43 \n
- #44 \n
- #45 \n
- #46 \n
- #47 \n
- #48 \n
- #49 \n
- #50 \n
- #51 \n
- #52 \n
- #53 \n
- #54 \n
- #55 \n
- #56 \n
- #57 \n
- #58 \n
- #59 \n
- #60 \n
- #61 \n
- #62 \n