CONTRIBUTING.MD

Unify-UI (TailwindCSS) Contributing Guide

Every contribution is welcome to this open source project. However, before submitting your contribution, be sure to take a moment and read the following guidelines.

• Unify-UI (TailwindCSS) Contributing Guide
  • Don't know how to contribute or new to Open Source?
  • Have a question?
    • Prerequisites
      • Vs Code Extensions
  • commit-convention
  • Pull Request Guidelines
    • Steps to PR
  • Local Development

Don't know how to contribute or new to Open Source?

Take a look at :

1. How to Contribute to Open Source{:target="_blank"}
2. How to Contribute to an Open Source Project on GitHub{:target="_blank"}

Have a question?

1. Check our Github Issues{:target="_blank"} to see if someone has already answered your question.
2. Join our community on Discord{:target="_blank"} and feel free to ask everything you want.

Prerequisites

• Code Editor
• NodeJS

Vs Code Extensions

1. Tailwind Fold{:target="_blank"}
2. Tailwind CSS IntelliSense{:target="_blank"}

commit-convention

Pull Request Guidelines

• The main branch is basically a snapshot of the latest stable version. All development must be done in dedicated branches.

Steps to PR

1. Fork of this repository and clone your fork

2. Create a new branch out of the main branch.

3. Make and commit your changes following the commit convention.

Local Development

After cloning the repository, execute the following commands in the root folder:

1. Install dependencies

Make sure to install the dependencies:

npm install

2. Development Server

Start the development server on http://localhost:5173/

npm run dev