Primer React

A React implementation of GitHub's Primer Design System

Documentation

Our documentation site lives at primer.style/react. You'll be able to find detailed documentation on getting started, all of the components, our theme, our principles, and more.

Installation

Install @primer/react in your project with your package manager of choice:

npm install @primer/react

yarn add @primer/react

Template

The fastest way make a prototype or try Primer React without setting up a new project is by using our react template.

Roadmap

You can track our roadmap progress in the Roadmap Project Board, see more detail in the quarterly planning Discussions, and find a list of all the current epic tracking issues.

Contributing

We love collaborating with folks inside and outside of GitHub and welcome contributions!

👉 See the contributing docs for more info on code style, testing, coverage, and troubleshooting.

New Component Proposals

We welcome and encourage new component proposals from internal GitHub teams! Our best work comes from collaborating directly with the teams using Primer React Components in their projects. If you'd like to kick off a new component proposal, please submit an issue using the component proposal issue template and we will get in touch!

Contributing to Primer React

We welcome contributions from everyone, whether you're experienced or just starting out with open-source. Here’s how you can contribute:

1. Reporting Bugs:

   • Use the Issues page to report bugs. Please check existing issues to avoid duplicates.
   • Clearly describe the issue including steps to reproduce when it is a bug.

2. Submitting Enhancements:

   • Suggest your ideas for enhancements on the Discussions page.
   • Keep suggestions focused and clear to facilitate easy understanding and implementation.

3. Pull Requests:

   • Fork the repository and make your changes in a new branch.
   • Ensure your code adheres to the existing style of the project to best match the current codebase.
   • Write meaningful commit messages that accurately reflect each set of changes.
   • Submit a pull request with a comprehensive description of changes.

4. Code Review:

   • Respond to code review feedback promptly.
   • Engage constructively in the process to make the project better for everyone.

5. Stay Updated:

   • Regularly pull the latest changes from the main branch of the repository to keep your fork up-to-date.

6. Join the Community:

   • Join discussions to contribute to future roadmap planning. Your input helps shape the project!
   • Connect with other community members to share ideas and collaborate.

7. Follow Our Code of Conduct:

   • Please adhere to the Code of Conduct to create a welcoming and positive environment for all contributors.

By following these guidelines, you help to maintain the quality and cohesion of the project, making it better for everyone involved!