Create styleguides and pattern library for contributors #10
Description
We are aiming for a very high bar of design and user experience in HospitalRun. In order to hit that bar and scale the project well as it gains continually more features and contributors, we need to provide contributors (both engineers and designers) with a documented framework for styles and design patterns.
Without such a clearly documented and visible (should live on the docs/marketing site) framework, we run the risk of a continuously degraded level of design and user experience as the project grows. Having such a framework will also help lower the barrier to entry to contributing to the project by making sure developers and designers don't have to solve problems that have already been solved.
What
- CSS styleguide/documentation
- document the CSS practices we have established and are enforcing via the linter
- Pattern library
- bring consistency to the app by defining patterns and using them consistently
- surface all of the patterns in a pattern library format where contributors can copy markup
Where
For starters this could live in the repo in the contributing doc, but ideally it should live on the docs site where we can actually render elements from the pattern library in markup [similar to what we do with the GitHub styleguide.
cc @tangollama @jkleinsc per our 🍖 🎇 conversation this morning.