Skip to main content
Thank you for your interest in contributing to Mintlify Components! This guide provides guidelines and information for contributors.

​
Getting Started

1

Fork the repository

Create a fork of the Mintlify Components repository on GitHub.
2

Clone your fork locally

git clone https://github.com/YOUR_USERNAME/components.git
cd components
3

Follow the setup instructions

See the Development Setup page for detailed instructions.

​
How to Contribute

​
Reporting Bugs

  • Check the existing issues to avoid duplicates
  • Open a bug report using the template
  • Include reproduction steps, expected behavior, and actual behavior
  • Add screenshots or code snippets if helpful

​
Requesting Features or Improvements

  • Check existing issues first to avoid duplicates
  • Open a feature request using the template
  • For improvements to existing components, add the improvement label
  • Describe the use case and why it would be valuable

​
Submitting Changes

1

Create a new branch

Create a new branch from main for your changes:
git checkout -b feature/your-feature-name
2

Make your changes

Follow our code style guidelines and existing patterns in the codebase.
3

Add tests and stories

Add or update tests and Storybook stories as needed for your changes.
4

Run linting

Ensure code quality with Biome:
pnpm lint:check
5

Verify the build

Run the build to ensure everything compiles successfully:
pnpm build
6

Submit a pull request

Open a PR with a clear description following the PR template.

​
Issue Labels

We use three labels to categorize issues:
  • bug - Something isn’t working as expected
  • improvement - Enhancement to an existing component
  • feature request - Request for a new component or capability

​
Pull Request Guidelines

When you open a PR, you’ll see a template with sections for Summary and Test Plan. Please fill these out.
  • Keep PRs focused on a single change
  • Write clear commit messages
  • Update documentation if needed
  • Ensure all CI checks pass

​
Code Style

  • Use TypeScript for all code
  • Follow existing patterns in the codebase
  • Use Tailwind CSS for styling
  • Run pnpm lint:fix to auto-format code

​
Component Guidelines

When adding or modifying components:
  • Ensure compatibility with React 18 and 19
  • Support both light and dark themes
  • Make components accessible (ARIA attributes, keyboard navigation)
  • Add Storybook stories documenting usage
  • Export types for TypeScript users
See Creating Components for detailed instructions.

​
Questions?

If you have questions, feel free to:

​
License

By contributing, you agree that your contributions will be licensed under the MIT License.

Build docs developers (and LLMs) love

Get started for freeTalk to us