Skip to content

Commit

Permalink
docs: 📚 add README.md to each package (#524)
Browse files Browse the repository at this point in the history
  • Loading branch information
Vahid1919 authored Nov 10, 2023
1 parent 5447c69 commit 25168c2
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 28 deletions.
34 changes: 6 additions & 28 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,17 @@

- [Functionality & Integration](#functionality--integration)
- [How We Work](#how-we-work)
- [Milestones](#milestones)
- [Development Guidelines](#development-guidelines)
- [Guide on `//TODOs`](#guide-on-todos)
- [Adding Dependecies](#adding-dependecies)
- [Migration Guides](#migration-guides)
- [Pull Requests](#pull-requests)
- [Assignees and Reviewers](#assignees-and-reviewers)
- [Commit Messages](#commit-messages)
- [Squash and Merge Your Changes](#squash-and-merge-your-changes)
- [Quick Start](#quick-start)
- [Helpful Commands](#helpful-commands)
- [Tests](#tests)
- [Working with feature branches](#working-with-feature-branches)

## Functionality & Integration

Expand Down Expand Up @@ -132,32 +136,6 @@ Always perform a Squash and Merge when merging. This keeps the Git history clean

You can take a look at tests on Github. Users might be required to log in to [Chromatic](https://www.chromatic.com/). Make sure to login using your GitHub account to avoid any errors and access the checks related to the Pull Request.

## Quick Start

To get started with the code steps, follow these instructions:

Install `pnpm` package manager globally.

- https://pnpm.io/installation

```
pnpm i
cd packages/components
pnpm dev
```

These steps will install the necessary dependencies, navigate to the "packages/components" directory, and start the development server. You can now begin working on the components.

### Helpful Commands

```
$ pnpm fix // fix all formatting and linting in repo
$ pnpm verify // run tests and builds in repo
$ cd packages/components
&& pnpm dev // start dev server
&& pnpm test // run tests
```

## Working with feature branches

As stated in the [release-guide.md](./packages/components/docs/release-guide.md#feature-branch-release) document, the SDS offers using a feature branch deployment to test the implementation of a new feature in your own project environment.
Expand Down
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Solid Design System Monorepo

Monorepo for Union Investment's Solid Design System.

## Packages

**1. Solid**

The solid package contains all the components that make up the Solid Design System.

**2. Placeholder**

The placeholder package provides placeholder images that can be used alongside the Solid Design System components during development and prototyping.

**3. Tokens**

The tokens package contains all the design tokens used in the Solid Design System.

## Quick Start

To get started with the code steps, follow these instructions:

We use `pnpm` package manager, so make sure to have it installed globally before you start.

- https://pnpm.io/installation

```
pnpm i
cd packages/components
pnpm dev
```

These steps will install the necessary dependencies, navigate to the "packages/components" directory, and start the development server. You can now take a look at our existing components or begin working on new ones.

### Helpful Commands

```
$ pnpm fix // fix all formatting and linting in repo
$ pnpm verify // run tests and builds in repo
$ cd packages/components
&& pnpm dev // start dev server
&& pnpm test // run tests
```

## Contributing

We welcome contributions from the community! If you'd like to contribute to any of the packages or improve the Solid Design System, please follow our [contribution guidelines](CONTRIBUTING.md) provided in this repository.

## License

This repository is licensed under MIT, except the fonts, icons and images, which are licensed under their respective licenses. Read the [full license](./packages/components/LICENSE.md) for more information.
5 changes: 5 additions & 0 deletions packages/tokens/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Tokens

The Solid Design System Tokens package provides a collection of design tokens for colors, typography and spacing. It ensures design consistency and collaboration between our designers and developers when building components for the Solid Design System.

Check out the [full documentation](https://solid-design-system.fe.union-investment.de/x.x.x/storybook/) for detailed information.

0 comments on commit 25168c2

Please sign in to comment.