projects, community and github: 4/10/2011
Post on 17-Oct-2014
1.951 views
DESCRIPTION
Projects, Community and Github: CodeConf April 10, 2011TRANSCRIPT
Projects, Community and Github
Andy Lester@petdance
Who is Github for?
Developers,developers,
developers,developers,
Github is notfor end users.
Whoo! Exposure!
Nat has 171,000 readers at radar.oreilly.com
Somebody clicks the link and wants to download it, and what they're presented with is a dev-oriented home page.
The download link isn't very descriptive.
Github is for those who like to
build from source.
Your usersprobably don't.
To the newcomer,the source treeis unimportant.
What's it do?
What's it look like?
Do I want to use it?
Make a project site.
• Answer the newcomer's questions.
• Aimed toward the end users.
• Users who are not as ninja as you.
• Make download + install incredibly obvious.
Make a project site.
Make a project site.
Get your own domain.
• 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/
Visible, documentedreleases matter!
Releases matter!
Release for simplicity
• Releases are an affirmation: "Yes, you can use this."
• Single, verifiable tarball.
• Nobody wants to run autoconf.
• Users expect them.
Release for historyand visibility
• Lets others build on your work.
• Make a milestone with history.
• Maintain an accurate, human-written changelog of all releases.
• A dump of commit messages is not a changelog!
Optimize for your users' sake,
not your own.
The needs of the many outweigh the needs of the few, or the one.
About me
About @petdance
• Perl guy: ack, prove, WWW::Mechanize
• Programming for money since the 1980s
• I sling PHP (eww!) for B2B web apps for a midsize corporation.
• From the midwest, Chicago area
• Diversity = good(c.f. @ginatrapani yesterday)
"Dad, if you don't get it, it's because I didn't do it."
Github projects have a low barrier to entry.
The good part:Anyone can do it.
The bad part:Anyone can do it.
Newbies expect their changes to be accepted.
"Can't you just...?"
Be gentle in your rejections.
Brevity may be perceived as harsh.
That box is too small.
You want to accept changes from newbies if
at all possible.
Don't reject patches just because of...
• No tests
• No documentation
• Not following code standards
• Those can all be fixed!
In this morning's mail...
I am happy to 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).
Make a project guide
• Small chunks of the elephant
• "TODO: Better error handling" is not helpful to the newbie.
• Project direction
• Coding standards
• Workflow + branch strategy
Monitor your network
Thank you• Put yourself 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.