Skip to content

Latest commit

 

History

History
131 lines (85 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

131 lines (85 loc) · 3.11 KB
Raw

Contributing

Thanks for your interest in contributing to ui.sast.fun. We're happy to have you here.

Please take a moment to review this document before submitting your first pull request. We also strongly recommend that you check for open issues and pull requests to see if someone else is working on something similar.

About this repository

This repository is a monorepo.

Structure

This repository is structured as follows:

packages
├── ui-react
│    └── lib
│       └── ${component-name}
│          ├── index.module.scss
│          └── index.tsx
└──  ui-universal
      └── lib
           └──components
                └── ${component-name}
                   ├── index.module.scss
                   └── index.tsx
docs
└── docs
Path Description
packages/ui-react The React components for the website.
packages/ui-universal The web components for the website.
docs The docs for the components.

Development

Fork this repo

You can fork this repo by clicking the fork button in the top right corner of this page.

Clone on your local machine

git clone https://github.com/your-username/SAST-UI.git

Navigate to project directory

cd SAST-UI

Create a new Branch

git checkout -b my-new-branch

Install dependencies

pnpm install

Run a workspace

You can use the pnpm --filter=[WORKSPACE] command to start the development process for a workspace.

Examples

  1. To run the sast-ui-react.vercel.app website:
pnpm run ui-react:dev
  1. To run the ui-react package:
pnpm run ui-react:start
  1. To run the ui-universal package:
pnpm run ui-uni:dev

Documentation

The documentation for this project is located in the docs workspace. You can run the documentation locally by running the following command:

pnpm run docs:dev

Documentation is written using MDX. You can find the documentation files in the docs directory.

Commit Convention

Before you create a Pull Request, please check whether your commits comply with the commit conventions used in this repository.

We don't allow git commits, please use pnpm commit and follow the steps to select your commit.

pnpm commit

Requests for new components

If you have a request for a new component, please open a issue on GitHub. We'll be happy to help you out.

Testing

Tests are written using Vitest. You can run all the tests from the root of the repository.

Currently only the react component library supports test, and the test code is in development

pnpm --filter @sast/ui-react test

Please ensure that the tests are passing when submitting a pull request. If you're adding new features, please include tests.