Contribution Guide

OpenVue is an open source Vue UI library, dedicated to providing high-quality, versatile, and accessible UI components that help developers build better applications faster.

Development Setup

To begin with, clone the OpenVue repository from GitHub:

git clone https://github.com/openvi-foundation/openvue.git
cd openvue

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

npm run setup
npm run dev

Project Structure

OpenVue utilizes a monorepo architecture, the libraries are located at packages folder and the website is at apps/showcase.

- apps
  - showcase                // website
- packages
  - auto-import-resolver    // unplugin resolver
  - core                    // core api
  - icons                   // primeicons as sfc
  - metadata                // list of components and directives
  - nuxt-module             // module for nuxt    
  - primevue                // main package of components and directives
  - themes                  // presets of styled mode

OpenVue 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. Your expertise can help others solve problems and improve their experience with OpenVue.

The design tokens and styling system underpin the whole component library. Any core structural changes, such as adding new props, events, or updating design tokens, should be communicated with the core team to ensure consistency and compatibility.

Join the discussion on GitHub to connect with OpenVue maintainers and fellow contributors, discuss the areas you want to contribute to, and receive feedback.

The project offers an organization structure involving contributors and the core team:

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

By contributing, you'll be helping grow and strengthen the Vue ecosystem's open source community. Contributors and Committers will be listed on our team page, and you'll gain visibility within the community while sharpening your skills alongside other developers who care about open source.

You'll be invited to a private communication channel at Discord to get in touch with the core team.

When a community member is offered the Contributor role, they are expected to sign a Contributor License Agreement (CLA) for legal purposes. This helps protect both the contributor and the project.