Welcome to the PrimeReact Contribution Guide and thank you for considering contributing.
PrimeReact is a popular React library maintained by PrimeTek, a company renowned for its comprehensive set of UI components for various frameworks. PrimeTek is dedicated to providing high-quality, versatile, and accessible UI components that help developers build better applications faster.
To begin with, clone the PrimeReact repository from GitHub
git clone https://github.com/primefaces/primereact.git
cd primereact
Then run the showcase in your local environment at http://localhost:3000/.
npm install
npm run dev
- components
- doc // Documentations
- lib // Components
- pages // Routing Pages
- styles // Themes and Styles
- service // Demo Services
PrimeReact is a community-driven project backed by the expertise and sponsorship of PrimeTek, and we appreciate any help you can provide. Here are some areas where you can contribute:
Help us manage issues by;
We encourage you to send pull requests, especially for issues tagged with the help-needed label.
Assist other users by participating in the issue tracker, GitHub Discussions, and the PrimeLand Discord server. Your expertise can help others solve problems and improve their experience with PrimeReact.
PrimeReact 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 PrimeLand Discord server to connect with PrimeReact 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.
PrimeTek offers an organization structure involving contributors and the core team:
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.
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 PrimeReact codebase.
PrimeTek prefers to hire team members from open source committers, so you may be offered a full-time position when a position becomes available.
Contributing to PrimeReact comes with several benefits. Being part of an open-source project will enhance your career and open up exciting opportunities. Contributors and Committers will be listed on our team page. You'll gain significant visibility in the developer community while improving yourself as a professional.
You'll be invited to a private communication channel at Discord to get in touch with PrimeTek. In addition, contributors have access to all PrimeReact add-ons like Premium Templates, Blocks, and UI Kit free of charge.
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 PrimeTek.