Contributing to OSS (Scalator 2020-01-22)
0 likes36 views
This document contains slides from a presentation by Ignasi Marimon-Clos on contributing to open source software projects. It discusses various ways to contribute including code, documentation, forums, and more. It also covers impediments to contributing like lack of confidence and provides tips such as starting with small issues, writing good commit messages, and using tools like GitHub and hub to facilitate the contribution process.
Contributing to OSS (Scalator 2020-01-22)
- 1. @ignasi35 Contributing to OSS Ignasi Marimon-Clos (Lightbend) https://github.com/ignasi35/contributing-oss
- 2. @ignasi35 A boring slide-deck I put together on my way here Ignasi Marimon-Clos
- 3. @ignasi35 Stuff I wished someone had told me before I became a full time OSS contributor Ignasi Marimon-Clos
- 5. @ignasi35 Contributing • Code (my PR’s) • Issue • 3rd party PR review • …
- 6. @ignasi35 Contributing • Project Site • Docs • Forums • Chats • Stack Overflow • Talks • Workshops • Blogposts • Tutorials • …
- 7. @ignasi35 Contributing • Code • Issue • PR review • Convention files, CI tunning, templates, … • Features • Fixes • Lint-ing • Code cleanup • Commenting • Triaging • Voting • Cleanup
- 9. @ignasi35 Impediments • It’s all in your head • Really • Even pros make mistakes • Yeah, just do it • It’s all in your head
- 10. @ignasi35 Fighting the Impediments • Allocate fixed weekly time • Sign up to Hacktoberfest
- 12. @ignasi35 Fighting the Impediments • No-one is watching. And if someone is watching, that’s even better! You will mess things up, but after 3 years and 200 PRs your successes will exceed your messes.
- 13. @ignasi35 Tips
- 14. @ignasi35 Tips - code • How To Write a Git Commit Message • How to write a PR (to OSS) Message • Manage expectations (newbie, need-help, low dedication, seek-guidance, “WIP - …”) • Why did you do this PR? Related issues? Related discussion (SO/forums/chat)? Why solve it like this (trade-offs)? • Read CONTRIBUTING.md • Follow steps in PR template (if exists)
- 15. @ignasi35 Tips - code • How To Write a Git Commit Message • How to write a PR (to OSS) Message • Manage expectations (newbie, need-help, low dedication, seek-guidance, “WIP - …”) • Why did you do this PR? Related issues? Related discussion (SO/forums/chat)? Why solve it like this (trade-offs)? • Read CONTRIBUTING.md • Follow steps in PR template (if exists) META
- 16. @ignasi35 Tips - code • Start small • Really small • Or automated (lint, automated replace, …) • There’s always time for a bug fix or even a new feature. You’ll get there. Know the irks, the layout and the team first.
- 18. @ignasi35 Tips - tools • GH Issue Link Status
- 19. @ignasi35 Tips - tools • Octotree
- 20. @ignasi35 Tips - tools • Refined Github
- 22. @ignasi35 Tips - tools • Adopt/Invent conventions • Automate according to those conventions • Hack your git
- 23. @ignasi35 Tips - choosing • Filter issue by label: “needs-help”, “good-first-issue”, “help wanted”, “cant-reproduce”, … • Look for PRs sent by other contributors. These usually require less knowledge of the code base so they are a good entry point.
- 24. @ignasi35 More…