Skip to content

Commit

Permalink
Add tooling content
Browse files Browse the repository at this point in the history
  • Loading branch information
kamranahmedse committed Sep 13, 2022
1 parent 8154305 commit 5b27d23
Show file tree
Hide file tree
Showing 17 changed files with 53 additions and 17 deletions.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Component catalog
# Component Catalog

Isolate your UI components’ environment outside of your product codebase to make sure they’re not dependent on any global dependencies and can be easily reused.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Documentation
# Documentation

Having your code documented is key to driving adoption and reducing the load on the contributors.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Code style
# Code Style

Having a defined code style helps align the way code’s written in the system and increases development velocity. It should be automated with the tools provided for each platform.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Unit testing
# Unit Testing

Every part of the design system should be covered with unit tests. Once your system’s adopted, any change in the isolated environment may affect how the product works.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Accessibility testing
# Accessibility Testing

Design systems should cover accessibility as much as possible. Making this automatic reduces the risk of inaccessible components or user flows in the product.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Semantic versioning
# Semantic Versioning

Version your code with semantic versioning that dictates how version numbers are assigned and incremented.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Release strategy
# Release Strategy

Design system releases should be automated and ideally use scripts ran locally or in remote CI pipelines to prevent broken releases.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Commit guidelines
# Commit Guidelines

Automate the generation of your changelog by adopting a commit message guidelines that categorise and define the changes being made.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Pr templates
# Pull Request Templates

Create pull request templates that outline the change being proposed to facilitate productive discussions.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Contribution guidelines
# Contribution Guidelines

Define the process of contributing to the code of the design system. Document everything in a discoverable place to make it easier for everyone to contribute.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Development
# Development

One of the main challenges in developing a design system isn’t building the components. It’s making your code stable, easy to read and contribute to.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Design editor
# Design Editor

There are many design editors available in the market today with the most popular names being Sketch, Figma and Adobe XD. If you're unsure which route to go down it's often best to speak with your team.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Plugins
# Plugins

Most popular Design Editors (Sketch and Figma, especially) come with third-party plugin support. Whilst it's best to use the editors in-built tools for laying out your components, plugins can bring in a range of useful data to populate them.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Version control
# Version Control

Having your design versioned with semantic versioning will allow you to easily align design with development, roll back faulty changes and release changes in code and design at the same time.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Contribution guidelines
# Contribution Guidelines

Define the process of contributing to the UI and UX of the design system and document it in a discoverable place to make it easier for everyone to contribute.
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
# Design
# Design

The UI and UX in a design system need to be tied to development as much as possible. The tools in this checklist should help designers and developers work better together.

Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
# Tooling
# Tooling

To make things efficient for anyone using your design system, make tooling essential. Find the workflows where you can integrate things with the tools people use. This helps organically spread your design system and make it crucial to people’s daily work.

0 comments on commit 5b27d23

Please sign in to comment.