Skip to content

Commit

Permalink
update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
shaharzil committed Mar 14, 2024
1 parent 562cb93 commit 0c595ff
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 31 deletions.
6 changes: 1 addition & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
- [ ] I have read the [Contribution Guide](../packages/core/CONTRIBUTING.md) for this project.
34 changes: 22 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <my_branch> && git pull origin master --tags`
2. Update master branch and rebasing your branch on it: `git checkout master && git pull && git checkout <my_branch> && git rebase master`
```
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
16 changes: 2 additions & 14 deletions packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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

Expand Down Expand Up @@ -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

0 comments on commit 0c595ff

Please sign in to comment.