Skip to content

Latest commit

 

History

History
78 lines (47 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

78 lines (47 loc) · 1.9 KB
Raw

Contributing

Thanks for your interest in contributing to HyperTheme Editor.

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>/hypertheme-editor.git
cd hypertheme-editor
  1. Install all dependencies by running:
yarn
  1. Build the project:
yarn build
  1. Start Storybook:
yarn storybook

Project Commands

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

yarn build: build all the packages

yarn storybook: run Storybook for components development

Commit convention

HyperTheme 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.

Todo list

HyperTheme Editor is in a preview state, it will be awesome if you want to help with one of these tasks:

  • Tests: we need tests, we just started working on it: check the setup-tests branch for more information.
  • Recoil issue: when importing from @hypertheme-editor/chakra-ui-core and not from @hypertheme-editor/chakra-ui recoil causes a crash.
  • Stories: Storybook stories are just a draft, we need a better structure and better stories.
  • Material UI: mui version is not implemented.