How to Contribute
Learn how to contribute to AI Elements.
AI Elements welcomes contributions from the community. Here's how you can help.
Types of Contributions
Bug Reports
Found something broken? Open an issue with:
- A clear description of the problem
- Steps to reproduce
- Expected vs actual behavior
- Your environment (Node version, framework, etc.)
Documentation
Help improve the docs by:
- Fixing typos and unclear explanations
- Adding code examples
- Improving component documentation
- Writing tutorials
Bug Fixes
Fix issues in existing components. Check the open issues for bugs to tackle.
New Components
Add components that help developers build AI interfaces. See New Components for requirements.
Enhancements
Improve existing components with:
- Better accessibility
- New features
- Performance improvements
- Improved TypeScript types
Getting Started
- Fork the repository
- Clone your fork:
git clone https://github.com/your_username_here/ai-elements.git- Install dependencies:
pnpm install- Create a branch:
git checkout -b feature/your_feature_name_here- Make your changes
- Run tests and linting:
pnpm test
pnpm run check- Submit a pull request
Pull Request Guidelines
- One feature or fix per PR
- Write a clear description of your changes
- Include screenshots for visual changes
- Update documentation if needed
- Ensure tests pass
See the full CONTRIBUTING.md for detailed guidelines.