This document discusses best practices for open source projects and frameworks, including being respectful of all community members, having high-quality documentation, following semantic versioning, being transparent about releases and security fixes, and providing migration guides for breaking changes. It also recommends having opinions but flexibility in code generation and conventions, future-proofing APIs, and learning from mistakes in an open and rewarding process.

1. CakePHP
The Yum and the Yuck

3. Mistakes
I’ve made a few.

4. Success
I’ve had a bit of that too.

5. Disclaimer
This is not intended to be mean.

6. Community

7. Be respectful
Everyone starts as a newbie.

8. No test, no bug
High entry barriers are not healthy

9. Set a good example
People will follow.

10. Conflicts
Ego, language & culture.

11. Empower others
Trust people who have proven themselves.

12. Be transparent
“Open” is an important part of open source.

13. Documentation

14. Maintenance hell
Make docs dead easy to maintain

15. Sphinx +
ElasticSearch
Winning combination

16. Use simple tools
Make docs accessible, & easy to contribute to.

17. Deployment
Push to
jenkins
ssh
github make

18. Search & offline
docs

19. Releases &
Upgrading

20. Releasing must
be simple
26 releases this year so far.

21. Version numbers
matter.
Semantic versioning is important.
http://semver.org

22. Security fixes
Be transparent and respond quickly.

23. Breaking
compatibility
Mistakes should be fixed.

24. Migration guides
Document what changes/breaks.

25. Upgrade tools
CLI sugar

26. Building a
Framework

27. Have opinions

28. People will hate
you.

29. People will love
you.

30. Code generation
Powerful, but relies on coupling.

31. Intelligent defaults
Make good ideas the standard

32. Derp defaults
When ideas age poorly.

33. Conventions
And configuration.

34. Conventions
Can lead to magic.

35. Magic can be evil
We meant to help, really.

36. Don’t Guess
Computers are stupid.

37. Future proof APIs
Option parameters make growing easy.

38. “Declarative”
interfaces
Kind of suck in PHP

39. Say no to features
Save your sanity.

40. In closing,

41. Make mistakes
Falling down is an effective way to learn.

42. Try this at home
Open source is hard, but rewarding

43. Thank you
https://joind.in/12707
!
Github - markstory
Twitter - mark_story