Contributing

Thanks for your interest in contributing to UVCanvas.

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.

If you need any help, feel free to reach out to @nhciao.

Structure

This repository is structured as follows:

core
└── lib
    ├── components
    └── content

site
├── public
└── src
    ├── app
    │   ├── (common)
    │   └── docs
    ├── components
    │   ├── registry
    │   └── ui
    ├── lib
    └── mdx

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/uvcanvas.git

Navigate to project directory

cd uvcanvas

Create a new Branch

git checkout -b my-new-branch

Install dependencies

cd core
yarn
cd ../site
yarn

Documentation

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

cd core
yarn dev

# In another terminal
cd site
yarn dev

Documentation is written using MDX. You can find the documentation files in the site/src/app/docs directory.

Components

We use a registry system for developing components. You can find the source code for the components under core/lib/components.

When adding or modifying components, please ensure that:

• You update the documentation.

Requests for new components

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