Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 2.53 KB

REUSABLE_COMPONENTS.md

File metadata and controls

43 lines (30 loc) · 2.53 KB

Reusable components

Every agnostic component (UI control, extension, helper, etc) should be created in a separate repository and in Swift.

Your component should be unit tested and documented.

Table of Contents

Steps to create a component

Steps to ship a component

  • Make sure that the README states what makes this component different than the other ones - simply having been made by us is probably not enough. It's very important that your README is 🌟 fabulous 🌟.
  • Provide a super-simple example on how to get the component up and running.
  • If the component is dependent on other frameworks, explain why they're needed and what they do. Don't assume that people know everything.
  • If it's a visual component, include a .gif showing how it works or what it does. It helps people understand your component without having to clone, build and run your project.
  • Make sure to have a cool logo 😎

Publicizing your component

Always express that you are part of a team, use phrases like "We did this" rather than "I did this".

Take the time to compose personal tweets to all your recipients. Copy-pasting one message to everyone makes you sound like a robot and feels spammy -- don't do this.