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
- Development
- Commits & releases
- Deprecation process
- Testing with your own project locally
- Get involved
- Reach out to us
- License
- Code of Conduct
- Contributors โจ
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.
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 usein the root of the repo
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.
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
We follow a structured deprecation process to ensure smooth transitions when components, props, and features are being phased out. Deprecations are announced at least one major version in advance, with clear migration paths and runtime warnings.
Read more about our deprecation guidelines here
You can test changes to a package of this monorepo in your own project locally by taking the following steps:
- Run
npm run-script buildin the desired package's directory to ensure your latest changes have been built - Run
npm linkin the desired package's directory - Change to your local project's directory and run
npm link NAME_OF_PACKAGEto link to the local version of the package (e.g.npm link @contentful/f36-components)
We appreciate any help on our repositories. For more details about how to contribute to a package, see the README of the corresponding package.
You can reach out to us using the Contentful Community Discord.
Create an issue using one of the templates 
This repository is published under the MIT license. The Geist typeface included in this repository is covered by its own license.
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.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!