In order to document components and modules in our pattern library we need to outline some criteria on the usage and do’s and don’ts.
- What is it and what does it do? Describe the module and how it functions.
- When to use it: Describe what it is used for and provide an example if possible.
- Rules of application: Communicate the do’s and don’ts.
- Provide any additional design related instructions: Reference / link any PSD’s or notes associated with the usage that may live outside of Fractal.
Make a note of these design rules in the README file for each pattern/module in the repo. You will need permission to access the private repository in github.