Thank you for your interest in contributing to Mintlify Components! This guide provides guidelines and information for contributors.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/mintlify/components/llms.txt
Use this file to discover all available pages before exploring further.
Getting Started
Fork the repository
Create a fork of the Mintlify Components repository on GitHub.
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
improvementlabel - Describe the use case and why it would be valuable
Submitting Changes
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:fixto 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
Questions?
If you have questions, feel free to:- Open a GitHub Discussion
- Check our documentation