Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

StripeCon New Zealand 2017 - Danae Miller-Clendon - Building SilverStripe modules to represent your company

99 views

Published on

As a web developer at Toast, Danae is immersed in the open source community both as a contributor and user. Danae talks about building SilverStripe modules to best represent your company.

Published in: Technology
  • Be the first to comment

  • Be the first to like this

StripeCon New Zealand 2017 - Danae Miller-Clendon - Building SilverStripe modules to represent your company

  1. 1. toast.co.nz
  2. 2. toast.co.nz Building SilverStripe modules to represent your company Danaë Miller-Clendon
  3. 3. toast.co.nz Who am I? ● SilverStripe developer for just over four years ● Currently work for Toast ● Developing with SilverStripe since ages ago
  4. 4. toast.co.nz Building SilverStripe modules to represent your company
  5. 5. toast.co.nz Who is this for? ● Freelance developer making your own modules ● Developer working for a company ● Someone from a company
  6. 6. toast.co.nz Presentation purpose Making modules and slowly upgrading them is almost a given for anyone working with SilverStripe. ● Add-Ons directory ● Open source ● GitHub issue tracking ● Community
  7. 7. toast.co.nz Presentation overview Choosing which style works best for you and your company ● Open Source vs Private ● Brand ● Maintenance and ongoing development
  8. 8. toast.co.nz Open Source
  9. 9. toast.co.nz Open source modules Benefits ● Available to the community ● Others can make suggestions ● Pull requests for improvements and bug fixes ● Increase brand awareness with good modules Drawbacks ● Available to the community ● Others can make suggestions ● Pull requests may never come ● Bad modules can tarnish your brand
  10. 10. Licensing ● How restrictive do you want to be? ● BSD License ● Use one that works for you and your company silverstripe.org/software/bsd-license/
  11. 11. Maintenance
  12. 12. Maintenance
  13. 13. toast.co.nz Semantic versioning ● Practical for even the simplest projects ● Push tags when you see fit ● Follow guidelines on semver.org ● Always make a major version change when modifying database fields
  14. 14. toast.co.nz Issue tracking ● Be thankful when you get an issue report ● They are helping you ● Be polite and friendly ● At the end of the day, you can ignore them
  15. 15. toast.co.nz Issue tracking
  16. 16. Allowing contributions ● CONTRIBUTING.md file ● Smaller changes are easier to automatically merge ● Larger pull requests require some QA docs.silverstripe.org/en/4/contributing/
  17. 17. CI Tools ● Unit tests ● Scrutinizer / Travis ● Add-Ons rating
  18. 18. toast.co.nz Private modules
  19. 19. toast.co.nz Private modules Benefits ● Can have very specific features to suit particular projects ● More control over the general direction of the project Drawbacks ● No one else but you and your team can fix bugs ● Services need to be self-managed ● Less control over the general direction of the project
  20. 20. Licensing ● Can be more restrictive than open source ● Depending on your client, it may need tweaking ● LGPL-3.0 ● Other GNU General Public Licenses opensource.org/licenses
  21. 21. toast.co.nz Private modules ● Private repository ● Access ● Package manager Structure
  22. 22. Private repository ● GitLab ● BitBucket ● Private GitHub
  23. 23. toast.co.nz Satis ● Install Satis on your server ● Give access between Satis server and your private repositories ● Poll for changes with Satis ● Add a reference in your composer.json to your Satis website URL blog.servergrove.com/2015/04/29/satis-building-composer-repository/ getcomposer.org/doc/articles/handling-private-packages-with-satis.md
  24. 24. toast.co.nz Public or private? Choose which method will work best for your team, brand, and company. Private modules for client-specific functionality Public modules to contribute to the community :)
  25. 25. toast.co.nz Brand
  26. 26. toast.co.nz Voice Consider the language you use, how you present yourself, and how colloquial you choose to be
  27. 27. toast.co.nz Documentation ● Resolves issues before they are raised ● Professional look ● Regularly updated documentation makes for a fantastic module ● Keep it lighthearted and friendly ● Tell and show your readers what to do github.com/thejameskyle/documentation-handbook
  28. 28. toast.co.nz Markdown/Linking within GitHub ● Cater your index page to all skill levels ● Go into detail in separate sections ● Use screenshots in CMS documentation, and code snippets in user reference github.com/thejameskyle/documentation-handbook github.com/praxisnetau/silverware-iconsetfield
  29. 29. toast.co.nz API Documentation Accurate, detailed, to-the-point ● Simple API’s can take advantage of Markdown tables ● Automatic API reference documentation works well for more advanced modules
  30. 30. API documentation examples Lever API Good interface, specific examples
  31. 31. API documentation examples
  32. 32. toast.co.nz API Reference Resources readme.io swagger.io contributor-covenant.org github.com/thejameskyle/ documentation-handbook
  33. 33. Documentation imagery ● ScreenToGif ● Use icons and images ● Screenshots for CMS documentation Dedicated website Brand in issue tracking and response ● Be helpful and polite ● Assume the user has minimum experience Extra additions
  34. 34. toast.co.nz Working on modules
  35. 35. toast.co.nz Module direction ● Who determines the direction of your modules? ● Take clients into consideration Workflow ● Roadmaps ● Pivotal ● Agile workflow
  36. 36. toast.co.nz Losing track How to avoid burying modules Put aside time each week or month to work on modules Keep your in-progress modules front-and-center.
  37. 37. toast.co.nz Working with releases ● You can push as many tags as you like ● Mark releases as pre-release if they aren’t stable ● Don’t lock your dependencies down unless you need to ● Keep on top of your dependencies help.github.com/articles/creating-releases/
  38. 38. toast.co.nz In conclusion Life happens.
  39. 39. toast.co.nz References material.io readme.io github.com/thejameskyle/documentation-handbook github.com gitlab.com semver.org contributor-covenant.org
  40. 40. toast.co.nz Thanks! Toast Ltd Linda at Toast for the slide design Material.io for icons

×