OpenVi Foundation
Docs

Contribute

We are building out the maintainer team now. If you know these libraries well, or want to, you are the person we are looking for.

Ways to help

Every project works the same way: issues and pull requests on GitHub, conversation on Discord. None of it needs prior involvement.

  • Fix something. Pick up an open issue, say you are on it, and open a pull request.
  • Report a bug well. A minimal reproduction is worth more than a long description. For OpenVue there is a one-click StackBlitz starter for exactly that.
  • Improve the documentation. Gaps and inaccuracies are bugs too.
  • Test accessibility. Real assistive-technology testing, reported against specific screen readers and versions.
  • Review. Reading and testing other people's pull requests is how most maintainers start.

Where each project needs help

OpenVue

  • Reproducing, triaging and fixing issues inherited from PrimeVue.
  • Migration reports: anything npx @openvue/migrate misses in a real codebase.
  • Accessibility testing with real screen readers, reported against specific versions.
  • Documentation gaps on openvue.dev, especially theming and unstyled mode. 
git clone https://github.com/openvi-foundation/openvue.git
cd openvue
pnpm install
pnpm run dev

Open issues · Contributing guide

OpenIcons

  • Icon requests, with the interface they are missing from.
  • New icons drawn on the 24×24 grid at the weight of the existing set; pnpm add-icon wires one in.
  • Bugs in the Vue components or the pi-* compatibility stylesheet. 
git clone https://github.com/openvi-foundation/openicons.git
cd openicons
pnpm install
pnpm build

Open issues

OpenUXKit

  • Theming bugs that surface in OpenVue but start in the engine or the presets.
  • Using the engine outside Vue, and reporting where it still assumes Vue.
  • Test coverage for the styled and themes packages. 
git clone https://github.com/openvi-foundation/openux.git
cd openux
pnpm install
pnpm run build:packages
pnpm test

Open issues · Contributing guide

OpenVolt

  • Components that break or look wrong after npx openvolt-vue add, with the Tailwind and OpenVue versions you are on.
  • Gaps in the Vite and Nuxt setup guides on openvolt.openvue.dev.
  • Projects moving from PrimeVue Volt: what the switch did not cover. 
git clone https://github.com/openvi-foundation/openvue.git
cd openvue
pnpm install
# the CLI and its components: packages/volt-cli

Open issues · Contributing guide

The templates and starters (Deni, OpenVue examples, OpenVue reproducer) take pull requests the same way. They are listed under templates and tools.

Before you open a pull request

  • Open an issue first for anything bigger than a bug fix, so the approach can be agreed on.
  • Keep the public API compatible with the release line it belongs to. A breaking change needs a documented migration path and waits for the next major version.
  • Include a test where the change is testable, and run the existing suites.
  • One logical change per pull request. Reviewable diffs get merged faster.

Becoming a maintainer

Commit access follows sustained, review-quality contribution rather than affiliation, on any of the projects. Start by picking up issues, then reach out on Discord or at contact@openvi.dev. See governance for how decisions get made.

Conduct and security

Participation in every repository and on Discord is covered by the code of conduct described in governance. Security issues are never reported as public issues: follow the security policy instead.