Skip to content

Latest commit

 

History

History
91 lines (56 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

91 lines (56 loc) · 1.82 KB
Raw

Contributing

Thanks for your interest in contributing to Chakra Admin.

We're so glad you want to help! 💖

Project Overview

This project is a monorepo managed with lerna.

It uses yarn to manage dependecies.

Setup the Project

  1. Fork this repository
  2. Clone your fork to your local machine
git clone https://github.com/<your_github_username>/chakra-admin.git
cd chakra-admin
  1. Install and Bootstrap all dependencies and cross dependencies by running:
yarn
yarn bootstrap
  1. Build the project:
yarn build
yarn bootstrap
  1. Start the example project:
cd example
yarn start:all

Update chakra-admin in the example project

In order to show the changes made in the packages directory inside the example project, you have to run:

# go to the chakra-admin project
cd chakra-admin

# build all packages
yarn build

# install updated packages
yarn bootstrap

You can now use your new or changed components in the example project.

Project Commands

Here's a list of the commands provided by this project:

yarn bootstrap: install all the cross dependencies

yarn build: build all the packages

yarn storybook: run Storybook for components development (WIP: currently not working)

Commit convention

Chakra Admin follows the Convential Commits specification.

Write the commit like this:

category(scope or module): your commit message

Where category is one of:

feat: changes that introduce new code or features

fix: changes that fix a bug (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 (README.md, etc.)

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