Build an open source hack

Hack+ workshop at Carnegie Mellon University on open source hacking

Transcript

1. Building your first open source hack An ACM@CMU Hack+ workshop Varun Arora, 5th Oct '13
2. I founded I am obsessed with open source (we are a start-up in Pgh making all of the world's K-12 learning content free and open, using the power of technology and communities) I write code for a living I am a (acm@)CMU alum
3. Courtesy: Fear Factor India TODAY IS ABOUT GEtTING YOU OUT OF YOUR COMFOrT ZONE
4. AGENDA < /> < /> < /> v1
5. STEP #1: HACK 20 minutes Courtesy: Aniroudh Koul on Flickr
6. ACM@CMU Hack+ workshop / 5th Oct '13 BUILDING YOUR FIRST OPEN SOUCE HACK Come up with an original idea for a useful hack / use an old project 2 OPTIONS 1.Go to goo.gl/nPNy5N 2.Pick a library 3.Using sample code, create a simple hack
7. AGENDA < /> < /> < /> v1
8. STEP #2: HOSTING 10 minutes Courtesy: The Tartan
9. ACM@CMU Hack+ workshop / 5th Oct '13 BUILDING YOUR FIRST OPEN SOUCE HACK YOUR OPTIONS • Hosting: SourceForge, GitHub, Google code, BitBucket, etc. • VCS: Git, SVN, Mercurial, etc.
10. AGENDA < /> < /> < /> v1
11. STEP #3: SHARE PROOF-OF-CONCEPT 5 minutes Courtesy: Aniroudh Koul on Flickr
12. AGENDA < /> < /> < /> v1
13. STEP #4: QUALITY 20 minutes Courtesy: Aniroudh Koul on Flickr
14. ACM@CMU Hack+ workshop / 5th Oct '13 BUILDING YOUR FIRST OPEN SOUCE HACK POOR QUALITY foss
15. ACM@CMU Hack+ workshop / 5th Oct '13 BUILDING YOUR FIRST OPEN SOUCE HACK testing • Python: UnitTest • Ruby: rspec, MiniTest, etc. • JavaScript: Qunit, Jasmine, etc. • Java: Junit • PHP: SimpleTest, PHPUnit • Go: (I don't know)
16. ACM@CMU Hack+ workshop / 5th Oct '13 BUILDING YOUR FIRST OPEN SOUCE HACK COMMENTING #Christmas tree initializer toConnect = [] toRead = [ ] toWrite = [ ] primes = [ ] responses = {} remaining = {}
17. ACM@CMU Hack+ workshop / 5th Oct '13 BUILDING YOUR FIRST OPEN SOUCE HACK FILES AND DIRS code more code pics blah.js
18. AGENDA < /> < /> < /> v1
19. STEP #5: LICENSING 15 minutes Courtesy: VillageVoice
20. ACM@CMU Hack+ workshop / 5th Oct '13 BUILDING YOUR FIRST OPEN SOUCE HACK “OPEN SOURCE” LICENSES • Apache License 2.0 • BSD 3-Clause "New" or "Revised" license • BSD 2-Clause "Simplified" or "FreeBSD" license • GNU General Public License (GPL) • GNU Library or "Lesser" General Public License (LGPL) • MIT license • Mozilla Public License 2.0 • Common Development and Distribution License • Eclipse Public License
21. AGENDA < /> < /> < /> v1
22. STEP #6: RELEASING 5 minutes Courtesy: Aniroudh Koul on Flickr
23. ACM@CMU Hack+ workshop / 5th Oct '13 BUILDING YOUR FIRST OPEN SOUCE HACK Mozilla's DILEMMA
24. ACM@CMU Hack+ workshop / 5th Oct '13 BUILDING YOUR FIRST OPEN SOUCE HACK Other considerations • Identifying outlets • Packaging source & binaries • Mailing lists
25. AGENDA < /> < /> < /> v1
26. STEP #7: DOCUMENTATION 35 minutes Courtesy: Aniroudh Koul on Flickr
27. ACM@CMU Hack+ workshop / 5th Oct '13 BUILDING YOUR FIRST OPEN SOUCE HACK IT'S !IMPORTANT Probably more important than coding the hack itself
28. ACM@CMU Hack+ workshop / 5th Oct '13 BUILDING YOUR FIRST OPEN SOUCE HACK THINGS YOU WANT TO INCLUDE • Installation info • With dependencies • Usage (with explanation) • Example(s) • Configuration • Versions / releases • Download binaries / source • Fork on _______ • API • FAQs • License • Compatibility / support
29. AGENDA < /> < /> < /> v1
30. STEP #8: CODEGASMS 10 minutes Courtesy: Aniroudh Koul on Flickr
31. ACM@CMU Hack+ workshop / 5th Oct '13 BUILDING YOUR FIRST OPEN SOUCE HACK FIND A CODE CONVENTION AND STICK TO IT I personally love and suggest Google's coding conventions
32. AGENDA < /> < /> < /> v1
33. STEP #9: BRANDING & COMMUNITY 20 minutes Courtesy: Aniroudh Koul on Flickr
34. ACM@CMU Hack+ workshop / 5th Oct '13 BUILDING YOUR FIRST OPEN SOUCE HACK Tools and resources to build a brand • ColourLover, SmashingMagazine • Rules: Grids, Consistency, Contrast, Whitespace, Alignment, leading, etc. • KISS • Imitate
35. ACM@CMU Hack+ workshop / 5th Oct '13 BUILDING YOUR FIRST OPEN SOUCE HACK CREATE A LOGO FOR YOUR HACK Using only simple polygons & a pre-defined color pallette
36. ACM@CMU Hack+ workshop / 5th Oct '13 BUILDING YOUR FIRST OPEN SOUCE HACK Managing a community • Issue tracking • Office hours: IRC / Email • Contributor roles • Salesmanship • Patches & processes
37. AGENDA < /> < /> < /> v1
38. Thanks! varun@theopencurriculum.org