UNPKG

@nebulaai/lumina-ui

Version:

Enterprise-grade glass morphism UI components with neural-inspired design system

114 lines (83 loc) 2.63 kB
# Contributing to Lumina UI We love your input! We want to make contributing to Lumina UI as easy and transparent as possible. ## 🚀 Quick Start 1. Fork the repo 2. Create your feature branch (`git checkout -b feature/amazing-feature`) 3. Install dependencies (`npm install`) 4. Make your changes 5. Run tests (`npm test`) 6. Commit your changes (`git commit -m 'Add amazing feature'`) 7. Push to the branch (`git push origin feature/amazing-feature`) 8. Open a Pull Request ## 🎯 Development Process ### Prerequisites - Node.js 18+ - npm or yarn - Git ### Setup ```bash git clone https://github.com/nebulaai/lumina-ui.git cd lumina-ui npm install npm run dev ``` ### Code Standards - TypeScript for type safety - ESLint + Prettier for code formatting - Conventional commits for commit messages - 90%+ test coverage for new features ### Component Guidelines - Follow the existing design patterns - Include proper TypeScript types - Add Storybook stories for new components - Ensure accessibility (WCAG 2.1 AA) - Test on multiple browsers ## 🐛 Reporting Bugs Create an issue with: - Clear description of the bug - Steps to reproduce - Expected vs actual behavior - Screenshots if applicable - Environment details ## 💡 Feature Requests We welcome feature requests! Please: - Search existing issues first - Provide detailed use case - Include mockups/wireframes if helpful - Consider scope and complexity ## 📝 Documentation - Update README.md for major changes - Add JSDoc comments for new APIs - Include examples in Storybook - Update TypeScript definitions ## 🎨 Design Principles - **Glass Morphism First**: Embrace frosted glass aesthetics - **Performance**: Optimize for 60fps animations - **Accessibility**: Support screen readers and keyboard navigation - **Mobile First**: Responsive design for all screen sizes - **Developer Experience**: Intuitive APIs with great TypeScript support ## 🔧 Testing ```bash # Unit tests npm test # E2E tests npm run test:e2e # Visual regression tests npm run test:visual # Accessibility tests npm run test:a11y ``` ## 📦 Release Process 1. Version bump following SemVer 2. Update CHANGELOG.md 3. Create GitHub release 4. Publish to npm 5. Update documentation site ## 💬 Community - [Discord](https://discord.gg/nebulaai) - General discussion - [GitHub Discussions](https://github.com/nebulaai/lumina-ui/discussions) - Ideas and Q&A - [Twitter](https://twitter.com/nebulaai) - Updates and announcements ## 📄 License By contributing, you agree that your contributions will be licensed under the MIT License. --- Thanks for contributing! 🙏