Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 1.38 KB

contributing.md

File metadata and controls

54 lines (35 loc) · 1.38 KB

Contributing to CuiCui

Thank you for your interest in contributing to CuiCui! We appreciate your support and look forward to your contributions. This guide will help you understand the directory structure and provide detailed instructions on how to add a new component to CuiCui or to modify the website.

Getting Started

The Roadmap

The roadmap for CuiCui is available in the project board on Featurebase. You can find the list of features, enhancements, and bugs that are planned for the next releases.

You can of course suggest new features or report bugs by opening a new issue on GitHub or by creating a new card on Featurebase.

Fork and Clone the Repository

  1. Fork this repository

    Click here to fork the repository.

  2. Clone your forked repository to your local machine

    git clone /~https://github.com/<YOUR_USERNAME>/cuicui.git

  3. Navigate to the project directory

    cd cuicui

  4. Create a new branch for your changes

    git checkout -b my-new-branch

  5. Install dependencies

    pnpm install

  6. Run the project

    pnpm run dev

    or

    pnpm run dev:turbo

Ask for Help

For any help or questions, please open a new GitHub issue.