Contributing Guide to ESC-UI

Prerequisites

Node.js v20.0.0 or later (lts/iron recommended)
PNPM v8.0.0 or later

Getting Started

Clone the repository

git clone https://github.com/esc-chula/esc-ui.git

Install the dependencies
```
pnpm install
```
Start the development server
```
pnpm storybook
```
Done! You can now start developing the components.

Practices

Commit Message: Use the following format for commit messages: type: description. For example, feat: add button component. Please check Conventional Commits for more information.
Branching: Use the following format for branch names: type/description. For example, feature/button.

Pull Request

Create a new branch from the main branch.
```
git checkout -b your-branch
```
Make changes to the code.
Staged and Commit the changes.
```
git add .
git commit -m "message"
```
Push the changes to the remote repository.
```
git push origin your-branch
```
Create a pull request to the main branch.
Done! You can now wait for the review.

Recommended Extensions for VSCode

WSL

Not required but recommended. If you have some time or encounter some issues, I recommend setting up WSL for development.

Please check the official documentation for more information.