Creating Quality Sample Code
summary
Creates GitHub-hosted samples for Twitter Labs with a focus on short, modular, runnable examples that actually work and get maintained. Uses a Postman collection, an open API specification, Python (sometimes run from R via reticulate), and small helpers like Twilio; applies the black autoformatter and runs peer review and a bug bash. Cuts examples from ~120 to ~35 lines, splits 60–70 line demos into <45, and fixes breakage as endpoints change.
AI-written summary · about
chapters (16)
- 0:00Start
- 1:36What Is Sample Code
- 3:01Twitter Sample Code
- 3:20Code Related Resources
- 5:28Readability
- 6:03Code Should Be Commented
- 6:58Readme
- 8:22Can I Build on Top of It
- 9:55How Others Perceive Your Code Samples
- 10:49Code Conventions
- 13:12Bug Bash
- 13:52What Exactly Does Good Sample Code Look like
- 14:45Create the Url
- 19:02Peer Review
- 22:49Accessibility
- 25:17Documentation Feedback
related talks
25mMaking Codebases Easier to Learn and Maintain
46mLightning Talks
04mCode Samples that Actually Compile
39mSharing Your Side Projects Online and Making Your Github the Best Résumé It Ca
35mMastering API Ops: Build Scalable Applications
40mNeed Examples? Write Your Own!
42mJust Bring Glue Leveraging Multiple Libraries To Quickly Build Powerful New Tools
44mGitHub Flavored Ruby