Welcome
Thank you for considering contributing to Component Library! This guide will help you get started.Getting Started
Fork and Clone
Install Dependencies
Development Workflow
Project Structure
Adding a New Component
1. Create Component Files
2. Component Template
3. Add Styles
4. Export Component
5. Add to Main Export
6. Create Storybook Story
7. Create Documentation
Code Standards
TypeScript
- Use TypeScript for all components
- Export prop interfaces
- Extend HTML element props when appropriate
Accessibility
- Include proper ARIA attributes
- Support keyboard navigation
- Provide accessible labels
- Test with screen readers
CSS
- Use CSS custom properties
- Follow BEM naming convention
- Keep specificity low
Testing
- Test all component variants
- Test accessibility
- Test keyboard navigation
- Test with different props
Pull Request Process
1. Create a Branch
2. Make Changes
- Write code following standards
- Add tests if applicable
- Update documentation
3. Commit Changes
Use conventional commits:feat: New featurefix: Bug fixdocs: Documentationstyle: Code style changesrefactor: Code refactoringtest: Testschore: Maintenance
4. Push and Create PR
- Clear description
- Screenshots (if UI changes)
- Link to related issues
Review Process
- Automated checks run (build, lint)
- Maintainers review code
- Address feedback
- Merge when approved
Documentation
Component Documentation
Update these files:- Component MDX in
docs/components/ - API reference in
docs/api/ - Storybook stories
Code Comments
Release Process
Maintainers handle releases:- Update version in
package.json - Update CHANGELOG.md
- Create git tag
- Publish to NPM
- Deploy documentation
Questions?
- Open an issue on GitHub
- Check existing documentation
- Review closed PRs for examples
Code of Conduct
- Be respectful and inclusive
- Provide constructive feedback
- Help others learn and grow