Contributing to Open Source PHP Projects

Developers in the PHP community work on really cool stuff. Whether it's a full-stack framework, CLI tool, ORM, or single-purpose library, developers are contributing code, filing issues, writing docs, adding tests, fixing typos, and more. Don't be afraid to jump in and help! OK, maybe it is a little intimidating at first, so that's why we will discuss everything you need to get started. We'll talk about open source in general, licenses, Git, GitHub, pull requests, autoloading and Composer, testing , project communication, documentation, and... well... that's probably plenty.

Transcript

1. Contributing to Open Source PHP Projects By Jeremy Lindblom (@jeremeamia)
2. Open Source Software
3. Open Source Software
4. Open Source Software
5. Open Source Software i.e., source code is available
6. Open Source Software i.e., source code is available associated with a license often developed in public and/or collaboratively
7. Open Source Licenses MIT BSD Apache 2 GPL PHP Mozilla Eclipse LGPL
8. Open Source Licenses MIT BSD Apache 2 GPL PHP Mozilla Eclipse LGPL
9. http://opensource.org
10. Contributing to OSS Find a project. (Ideally, something that you already use) — OR — Start a project. (Ideally, something that you already need)
11. Contributing to OSS Write Code: Bug Fixes, Features, Plugins, Tests, Improvements, etc. Write/Improve Docs Community Participation Run Tests Report Bugs Improve Automation Donate Money/In-Kind Use/Share the Software Say Thanks
12. How to NOT Contribute •  Be overly critical of projects/people •  Be rude or disrespectful •  Make unreasonable demands •  Never offer to help •  Be ungrateful for others' time/work •  Be offended if contributions rejected
13. What's in it for me? •  Improve the code you use •  Build reputation, résumé, and portfolio •  Learn new skills (including soft skills) •  Give back •  Personal satisfaction
14. Some Tools Git GitHub Composer Travis CI PHPUnit Markdown phpDoc IRC Phing Make Sphinx Etc.
15. Anatomy of an OS PHP Project
16. Anatomy of an OS PHP Project ?
17. Anatomy of an OS PHP Project +  lib/   +  tests/   +  LICENSE   +  README.md  
18. Anatomy of an OS PHP Project -­‐  lib/   +  src/      tests/      LICENSE      README.md  
19. Anatomy of an OS PHP Project +  build/   +  docs/      src/      tests/      LICENSE      README.md  
20. Anatomy of an OS PHP Project +  build/   +  docs/      src/      tests/      LICENSE      README.md  
21. Anatomy of an OS PHP Project    build/      docs/      src/      tests/   +  .gitignore  (and  other  dotfiles)            LICENSE      README.md  (and  other  documentation)   +  composer.json  (and  other  config)  
22. Anatomy of an OS PHP Project .coveralls.yml   .gitattributes   .gitignore   .gitattributes   .scrutinizer.yml   .travis.yml   CONTRIBUTING.md   LICENSE   Makefile   README.md   build.xml   composer.json   composer.lock   phpunit.xml.dist  
23. Anatomy of an OS PHP Project Some examples: •  https://github.com/symfony/symfony •  https://github.com/laravel/framework •  https://github.com/zendframework/zf2 •  https://github.com/guzzle/guzzle •  https://github.com/doctrine/doctrine2
24. Contribution Process 1.  Find out where people gather. (GitHub, IRC, Mailing List, etc.) 2.  Find or create an issue. 3.  Ask if you can work on it. 4.  Do the work. Include tests, if possible. 5.  Submit a pull request (PR).
25. GitHub Process 1.  Fork repository to your GitHub account. 2.  git  clone to your local machine. 3.  composer  install dependencies. 4.  Write code and tests. 5.  git  commit  and push to your fork. 6.  Create a PR to the original repo. 7.  Wait for someone to review and accept.
26. Let's give it a shot! https://github.com/seaphp/simple-project