Maintaining an Open Source repository

Little guide of how to be responsible Open Source maintainer.

Transcript

1. Maintaining an Open Source repository @phpanarchist DutchPHP 2019 #dpc19 #dpc19uncon Mario Blažek
2. www.netgenlabs.com • Mario Blažek • Software developer @Netgen • CFO • Believes in Open Source • Married to a beautiful wife • Father of two Who?
3. www.netgenlabs.com
4. www.netgenlabs.com • Just pushed code to Github repository • It is not time for a beer yet • … Day 0
5. www.netgenlabs.com • No comment • PHPUnit • PHPSpec • Kahlan • Peridot Tests
6. www.netgenlabs.com • PHP Code Style Fixer - php-cs-fixer • PHP Static Analysis Tool - PHPStan Command line tools - part 1
7. www.netgenlabs.com • Reconstruction tool - rector • PHP Mess Detector - phpmd • Static Analysis Tool - psalm • PHP Mutation Testing Framework - Infection Command line tools - part 2
8. www.netgenlabs.com • TravisCI (.travis.yml) • Scrutinizer (.scrutinizer.yml) • CodeCov (codecov.yml) • CodeClimate (.codeclimate.yml) • SymfonyInsight • PrettyCI (.php_cs) Remote tools
9. www.netgenlabs.com • https://readthedocs.org/ • https://docusaurus.io/ • https://www.mkdocs.org/ • https://www.gitbook.com/ • https://www.netgenlabs.com/Blog/The-most-overlooked- part-in-software-development-project-documentation Documentation
10. www.netgenlabs.com • https://asciinema.org/ Demos
11. www.netgenlabs.com • Is a MUST • Changelog != list of commits • https://keepachangelog.com/en/1.0.0/ Changelog
12. www.netgenlabs.com • Choose a proper license • Apache, MIT, GPLv3 • https://choosealicense.com/licenses/ • https://spdx.org/licenses/ • https://spdx.org/licenses/WTFPL.html Licensing
13. www.netgenlabs.com • Try to comply with semantic versioning principles • https://semver.org/ Versioning and releases
14. www.netgenlabs.com • Simple structure • Links to license, docs and changelog • Badges :) README
15. www.netgenlabs.com • https://github.com/thephpleague/skeleton • https://github.com/netgen/open-source-skeleton • https://github.com/php-pds/skeleton Skeletons
16. www.netgenlabs.com • Publish your package to https://packagist.org/ • And now the real work begins • Be responsible, collaborate • And now it’s the time for a beer ($) We are ready to go ‘live’
17. Questions?
18. Thank you! mario.b@netgen.hr twitter.com/phpanarchist