Contribution Guide

Mantle UI is an independent community-maintained React component library continued from the MIT-licensed PrimeReact v10 codebase. The project focuses on delivering high-quality, versatile, and accessible UI components for React applications.

Development Setup

To begin with, clone the MantleUI repository from GitHub

git clone https://github.com/Mantle-UI/mantle-ui.git
cd mantle-ui
 

Then run the showcase in your local environment at http://localhost:3000/.

npm install
npm run dev
 

Project Structure

- components
    - doc // Documentations
    - lib // Components
- pages // Routing Pages
- styles // Themes and Styles
- service // Demo Services

 

Mantle UI is a community-driven project, and we appreciate any help you can provide. Here are some areas where you can contribute:

Issue Triage

Help us manage issues by;

• Reproducing reported bugs
• Clarifying issue descriptions
• Tagging issues with appropriate labels

Sending Pull Requests

We encourage you to send pull requests, especially for issues tagged with the help-needed label.

Community Support

Assist other users by participating in the issue tracker, GitHub Discussions, and the Mantle UI Discord server. Your expertise can help others solve problems and improve their experience with MantleUI.

MantleUI has several add-ons such as UI Kit, Premium Templates, and Blocks that rely on the core library. Any structural changes in the core, such as adding new props, events, or updating design tokens, should be communicated with the core team to ensure consistency and compatibility.

Join the Contributors channel on the Mantle UI Discord server to connect with MantleUI staff and fellow contributors. In this channel, you can discuss the areas you want to contribute to and receive feedback. This channel is open to everyone who'd like to contribute.

Mantle UI uses a simple contributor structure involving community contributors and maintainers:

Contributor Role

After a certain period of frequent contributions, a community member is offered the Contributor role. On average, it may take about three months, but the exact duration can vary depending on the individual commitment.

Committer Role

If a contributor actively participates in the codebase and PRs, their role may be upgraded to a Committer level, providing direct commit access to the MantleUI codebase.

Employment

Strong open source contributions can lead to greater trust, broader responsibilities, and potential collaboration opportunities as the project grows.

Contributing to MantleUI comes with several benefits. Being part of an open-source project will enhance your career, broaden your visibility in the developer community, and help you grow as a professional.

Contributors may be invited to maintainer communication channels on Discord as collaboration deepens. Additional contributor benefits can evolve over time as the Mantle UI project and ecosystem grow.

Mantle UI does not currently require a separate Contributor License Agreement. Contributions are handled under the repository contribution policy and the project license.