Skip to content

contentful/forma-36

Repository files navigation

Forma 36 - The Contentful Design System

Contentful All Contributors

Forma 36 is an open-source design system by Contentful created with the intent to reduce the overhead of creating UI by providing tools and guidance for digital teams building and extending Contentful products

Table of contents

Creating new packages

We use Plop to create scripts that help you to scaffold new packages. In the root of the repo, you can run npm run-script generate. Then follow the steps in the CLI. Plop will generate the relevant files and add the relevant imports and exports to the main src/index.ts file required to make the component available when publishing the library. Read more about contribution to Forma 36.

Development

For local development, in the root of the repo run npm i to install all dependencies and then npm run-script build to build all packages. Now follow the instructions of the specific package you’re working on. You will find each package’s instructions in their README files, check the Packages section for a list of all packages.

In case you are having problems to install the dependencies, try using NVM to get the same node version we use by running nvm use in the root of the repo

Storybook for f36-components

We use storybook with our react component library to develop components. You can start it from the root of the repo, just run npm run-script storybook after building.

Commits & releases

Use npm run-script 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 main branch that contains a new changeset.

Read more about changeset here

Testing with your own project locally

You can test changes to a package of this monorepo in your own project locally by taking the following steps:

  1. Run npm run-script build in the desired package's directory to ensure your latest changes have been built
  2. Run npm link in the desired package's directory
  3. Change to your local project's directory and run npm link NAME_OF_PACKAGE to link to the local version of the package (e.g. npm link @contentful/f36-components)

Get involved

PRs Welcome

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

You can reach out to us 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?

Create an issue using one of the templates File an issue. 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.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Mike Mitchell
Mike Mitchell

💻 🚧
Johannes Bugiel
Johannes Bugiel

💻 🚧
Gui Santos
Gui Santos

💻 🚧 📖
Moe Shaaban
Moe Shaaban

💻 🚧 📖
Patrycja Radaczyńska
Patrycja Radaczyńska

💻 🚧 📖
Dominik Markušić
Dominik Markušić

🎨 📖
Kristoffer
Kristoffer

💻 🚧 📖
Alexander Suevalov
Alexander Suevalov

💻 🚧
Gracegross
Gracegross

🎨
Miretxu
Miretxu

💻
Tanya Bessonova
Tanya Bessonova

💻
John Whiles
John Whiles

💻
Guilherme Barbosa
Guilherme Barbosa

💻
Marco Link
Marco Link

💻
David Fateh
David Fateh

💻
Bruce Felt
Bruce Felt

💻
Daniel Vasylenko
Daniel Vasylenko

💻
kdamball
kdamball

💻
MarkusLaut
MarkusLaut

💻
Andreas Hörnicke
Andreas Hörnicke

💻
ChidinmaOrajiaku
ChidinmaOrajiaku

💻
Andi Pätzold
Andi Pätzold

💻 🐛
Wiktoria Dalach
Wiktoria Dalach

💻
Joshua Smock
Joshua Smock

💻
Yiotis Kaltsikis
Yiotis Kaltsikis

💻
Azer Koçulu
Azer Koçulu

💻
taye
taye

💻
dannyiacono
dannyiacono

💻
Grant Sauer
Grant Sauer

💻
João Ramos
João Ramos

💻
Ante Sepic
Ante Sepic

💻 🐛
Blair Rampling
Blair Rampling

💻
Daniel A. R. Werner
Daniel A. R. Werner

💻
Sergii Bezliudnyi
Sergii Bezliudnyi

💻
Manuel Spagnolo
Manuel Spagnolo

💻
Mohamed Turki
Mohamed Turki

💻
Ahmed T. Ali
Ahmed T. Ali

💻
Bruno Russi Lautenschlager
Bruno Russi Lautenschlager

💻
Chris Towler
Chris Towler

💻 🐛
Christoph Grabo
Christoph Grabo

💻
Colton Colcleasure
Colton Colcleasure

💻
Connor Bär
Connor Bär

💻
Danil Zakablukovskii
Danil Zakablukovskii

💻
Dominic Bonnice
Dominic Bonnice

💻
Khaled Garbaya
Khaled Garbaya

💻
Stefan Judis
Stefan Judis

💻
Thomas Jaggi
Thomas Jaggi

💻
Turcan Vladimir
Turcan Vladimir

💻
V. Milone
V. Milone

💻
Aris Plakias
Aris Plakias

💻
Kam Figy
Kam Figy

🐛
Peter Wielander
Peter Wielander

💻 🐛
Felix Boenke
Felix Boenke

🐛
damienxy
damienxy

💻 🐛
Nika Zawila
Nika Zawila

💻 🚧 📖
Sarah
Sarah

📖
th1nkgr33n
th1nkgr33n

🐛
Thomas Kellermeier
Thomas Kellermeier

🐛 💻
Ikko Ashimine
Ikko Ashimine

📖
Anil Kumar krishanshetty
Anil Kumar krishanshetty

💻 📖
Renato Massao Yonamine
Renato Massao Yonamine

💻
Charlie Chrisman
Charlie Chrisman

🐛
Jan van den Berg
Jan van den Berg

💻
SirGavin
SirGavin

🐛
Kathrin Holzmann
Kathrin Holzmann

💻 🚧
Bohdan Hutsol
Bohdan Hutsol

💻 🚧
Gary Hepting
Gary Hepting

🐛 💻
Rowadz
Rowadz

💻
Maxim Cheremisin
Maxim Cheremisin

💻
benomatis
benomatis

📖
Wake1st
Wake1st

💻
Ridwan Ajanaku
Ridwan Ajanaku

📖
Rémy Lenoir
Rémy Lenoir

🚧 💻 📖
Wojciech Maj
Wojciech Maj

🐛 💻
Lillian Bitner
Lillian Bitner

🚧 💻 📖
Lisa White
Lisa White

🚧 💻 📖
Eddie Chung
Eddie Chung

🚧 💻 📖
Marouen Ben Salem
Marouen Ben Salem

💻 📖 🐛
Kudakwashe Mupeni
Kudakwashe Mupeni

💻
Marta Sierosławska
Marta Sierosławska

💻
MayaGillilan
MayaGillilan

💻

This project follows the all-contributors specification. Contributions of any kind welcome!