Skip to content

Latest commit

 

History

History
150 lines (109 loc) · 4.11 KB

CONTRIBUTING.md

File metadata and controls

150 lines (109 loc) · 4.11 KB
Raw

Contributing

Thanks for your interest in contributing to Jolly-UI

About this repository

This repository is a monorepo.

Structure

This repository is structured as follows:

apps
└── docs
    ├── app
    ├── components
    ├── content
    └── registry
        ├── default
        │   ├── example
        │   └── ui
        └── new-york
            ├── example
            └── ui
packages
└── (config files)
Path Description
apps/docs/app The Next.js application for the website.
apps/docs/components The React components for the website.
apps/docs/content The content for the website.
apps/docs/registry The registry for the components.
apps/storybook Storbook for 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/ui.git

Navigate to project directory

cd jolly-ui

Create a new Branch

git checkout -b my-new-branch

Install dependencies

pnpm install

Examples

  1. To run the jollyui.dev website:
pnpm --filter=docs dev
  1. To run the storybook:
pnpm --filter=storybook 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 --filter=docs dev

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

Components

We use a registry system for developing components. You can find the source code for the components under apps/docs/registry. The components are organized by styles.

apps
└── docs
    └── registry
        ├── default
        │   ├── example
        │   └── ui
        └── new-york
            ├── example
            └── ui

When adding or modifying components, please ensure that:

  1. You make the changes for every style.
  2. You update the documentation.
  3. You run pnpm build:registry to update the registry.

Commit Convention

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

When you create a commit we kindly ask you to follow the convention category(scope or module): message in your commit message while using one of the following categories:

  • feat / feature: all changes that introduce completely new code or new features

  • fix: changes that fix a bug (ideally you will additionally reference an issue if present)

  • refactor: any code related change that is not a fix nor a feature

  • docs: changing existing or creating new documentation (i.e. README, docs for usage of a lib or cli usage)

  • build: all changes regarding the build of the software, changes to dependencies or the addition of new dependencies

  • test: all changes regarding tests (adding new tests or changing existing ones)

  • ci: all changes regarding the configuration of continuous integration (i.e. github actions, ci system)

  • chore: all changes to the repository that do not fit into any of the above categories

    e.g. feat(components): add new prop to the avatar component

If you are interested in the detailed specification you can visit https://www.conventionalcommits.org/ or check out the Angular Commit Message Guidelines.

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.