From 0c595ffd163b559e813b0d52b73d0d4963c648b6 Mon Sep 17 00:00:00 2001 From: shaharzil Date: Thu, 14 Mar 2024 11:44:44 +0200 Subject: [PATCH] update readmes --- .github/PULL_REQUEST_TEMPLATE.md | 6 +----- README.md | 34 +++++++++++++++++++++----------- packages/core/README.md | 16 ++------------- 3 files changed, 25 insertions(+), 31 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index bf078232fe..1832f447a4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,10 +3,6 @@ Thank you for contributing! Before we can review your submission, please fill the information below: -## Description - Please describe the changes you're making. Include the motivation for these changes, any additional context, and the impact on the project. If your changes are related to any open issues, please link to them here. -## Contribution Guide Compliance - -- [ ] I have read the [Contribution Guide](../packages/core/CONTRIBUTING.md) for this project. \ No newline at end of file +- [ ] I have read the [Contribution Guide](../packages/core/CONTRIBUTING.md) for this project. diff --git a/README.md b/README.md index ade338b61f..7abd409683 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,32 @@ ![image](https://user-images.githubusercontent.com/60314759/147566893-63c5209a-8b83-4f32-af61-8b4c350ec770.png) -This is a monorepo containing Vibe's maintained open-source packages. +Welcome to the Vibe Design System repository! This monorepo contains various open-source packages maintained by Vibe ([monday.com](https://www.monday.com)). -The packages are maintained using [lerna](https://github.com/lerna/lerna/tree/master/). +## Overview -## CI +Vibe Design System offers a collection of packages designed to streamline your development process and enhance the user experience. Below is a list of our main packages: -When pushing changes to the remote, lerna runs tests on all packages. -The CI will bump patch version of changed packages only, and only when the build is merge-to-master branch. +1. [core](packages/core/README.md): [monday.com](https://www.monday.com) React components library - [Storybook](https://style.monday.com). +2. [style](packages/style/README.md): [monday.com](https://www.monday.com) styling foundations library. -## FAQ +Each package comes with its own README providing detailed information about its usage, installation instructions, and getting started guide. -### Why does the CI for my PR run on all the packages? +## Installation -The CI looks for changes using git tags. If your branch is out of sync with the master branch, -you may have missing git tags on your branch, causing Lerna to "think" there are many new changes. -To solve this, make sure you pull the tags from `master` branch. Two of your options are: +Install the component library -1. Pull from master including tags: `git checkout && git pull origin master --tags` -2. Update master branch and rebasing your branch on it: `git checkout master && git pull && git checkout && git rebase master` \ No newline at end of file +``` +npm install monday-ui-react-core +``` + +## Getting Started + +If you're new to Vibe Design System, we recommend starting with our main package: + +- [core](packages/core/README.md): This is the core of the Vibe Design System. Follow the installation guide and getting started instructions to integrate it into your project. + + +## Contributing + +We welcome every contributor, please read the [contribution guidelines](packages/core/CONTRIBUTING.md) before submitting a PR diff --git a/packages/core/README.md b/packages/core/README.md index 56778b722c..c1d3b3cfbc 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -10,14 +10,6 @@ | --------- | --------- | --------- | --------- | --------- | --------- | | last 4 versions| last 4 versions| 14+| last 2 versions| last 2 versions| last 2 versions | -## Installation - -Install the component library - -``` -npm install monday-ui-react-core -``` - ## Usage Components are imported from the library's root entry: @@ -32,7 +24,7 @@ In order to load all the relevant CSS tokens, you should import the `tokens` fil import "monday-ui-react-core/tokens"; ``` -_If your project (or it's Storybook) is importing files differently - read more [here](DEPRECATED_IMPORTS.md)._ +_If your project (or it's Storybook) is importing files differently - read more [here](./DEPRECATED_IMPORTS.md)._ ### Font installation @@ -81,10 +73,6 @@ npm link npm start ``` -## Contributing - -We welcome every contributor, please read the [contribution guidelines](CONTRIBUTING.md) before submitting a PR - ## Themes -We support theming from the library to the component level using css variables - for more info on theming please read the [theme guidelines](THEME_README.md) file +We support theming from the library to the component level using css variables - for more info on theming please read the [theme guidelines](./THEME_README.md) file