Open Source Contributions: Examples/Demos

Are you thinking of contributing to Open Source this Hacktoberfest? You could contribute by building examples or demos to some of your favourite projects.

This was a lightning talk about some things that you may want to consider when contributing Demos or Examples.

Transcript

2. Contributing Examples & Demos
3. @Chatterboxcoder Developer Evangelist Twilio Nathaniel Okenwa
4. WHAT can I contribute?
5. • Examples • Demos • Templates
6. Example: A way of helping someone to understand something by showing them how it is used
7. WHICH projects can I contribute to?
8. Totally up to you! Your favourite products or tools: What are some of the products that you already know Git repositories: Look out for an `examples` or `demos` folder GitHub Issues: Open calls for demo contributions
9. Planning
10. Example: A way of helping someone to understand something by showing them how it is used
11. Recommendations 1. Keep the demo or example Basic 2. Focus on demonstrating a specific functionality or use case 3. Think about your target Developer Audience 4. Silo your demo/example
12. Building
13. Comment, Comment, Comment Use Descriptive Names Readability > Cleverness Follow Good Practices Refactorable Keep a Consistent Coding Style Make your code easy-to-follow
14. Documenting
16. Recommendations 1. Define prerequisites 2. Specify any architecture requirements 3. Step-by-Step setup instructions 4. Ask a friend to work through your instructions on their computer
17. Optional Extras Hosted Demos -- “Deploy to” Buttons -- Blog Post Walkthroughs
18. Thanks for listening! QUESTIONS