yizhuang / forma-36

A design system by Contentful

Forma 36 - The Contentful Design System

This is the monorepo for the Forma 36 design system by Contentful.

• Packages
  • Forma 36 React Components
  • Forma 36 FCSS
  • Forma 36 Tokens
  • Forma 36 Website (WIP)
• Adding packages
• Font Usage
• Commiting changes & releasing a new version
• Get Involved
• Reach out to us
• License
• Code of conduct

Packages

Forma 36 is a monorepo maintained using Lerna. Get started with Lerna by following this link: https://github.com/lerna/lerna

The monorepo is currently structured into the following packages:

• forma-36-website
  • This package includes the design system documentation which offers guidelines, best practices and examples. See the README here
• forma-36-react-components
  • A React component library built with Storybook. See the README here
• forma-36-fcss
  • CSS utility classes for spacing, typography, colors and transitions. See the README here
• forma-36-tokens
  • Forma 36 design tokens. See the README here

Adding packages

To add another package create a new directory in the packages folder. Make sure that the package name is prefixed with forma-36 (e.g. forma-36-css-utilities). Since we are using Lerna all package scripts are available from the root by running lerna run {script_name}

Font Usage

Forma 36 was designed to use ‘Avenir Next’ as primary font family. If a package is used in the context of app.contentful.com (e.g UI extensions) this font will be provided. We encourage licensing ‘Avenir Next’ when a package is used outside of Contentful related contexts.

Commits & Releases

Use yarn commit. This uses the Commitzen CLI to create a conventional commit message based on your changes. CI is setup to release all new commits on the master branch.

Get involved

We appreciate any help on our repositories. For more details about how to contribute to a package, see the README of the corresponding package.

Reach out to us

Maintainers

• Johannes Bugiel
• Mike Mitchell

You can also reach out using the Contentful community Slack. We've setup a channel #forma36 in which we announce latest changes and updates.

You found a bug or want to propose a feature?

• File an issue here on GitHub: . Make sure to remove any credential from your code before sharing it.

License

This repository is published under the MIT license.

Code of Conduct

We want to provide a safe, inclusive, welcoming, and harassment-free space and experience for all participants, regardless of gender identity and expression, sexual orientation, disability, physical appearance, socioeconomic status, body size, ethnicity, nationality, level of experience, age, religion (or lack thereof), or other identity markers.

Read our full Code of Conduct.