Contribution & Open Source
Help us improve Billing SDK - built with transparency and community collaboration
Billing SDK is built on the principles of open source software - transparency, collaboration, and community-driven development. We believe that great tools should be accessible to everyone and improved by collective effort.
Why Open Source?
- ๐ Transparency - Full visibility into how components work
- ๐ค Community - Built by developers, for developers
- ๐ Security - Open code means better security through peer review
- ๐ Innovation - Faster iteration through community contributions
- ๐ฐ Cost-Effective - Free to use, modify, and distribute
How to Contribute
We welcome contributions from the community! Whether you're fixing bugs, adding new components, or improving documentation, your help makes Billing SDK better for everyone.
Getting Started
- Fork the repository on GitHub
- Clone your fork locally
- Create a new branch for your changes
- Make your changes following our guidelines
- Test thoroughly to ensure everything works
- Submit a pull request with a clear description
Refer our CONTRIBUTING.md for more details.
Contribution Guidelines
Development Setup
Make sure you have Node.js 18+ installed and are familiar with React, TypeScript, and Tailwind CSS.
Adding New Components
When adding new components:
- Follow the existing component structure and naming conventions
- Include comprehensive TypeScript interfaces
- Add proper documentation with examples
- Ensure responsive design and accessibility
- Test with multiple themes
Code Style
- Use TypeScript for all components
- Follow the existing code formatting
- Use meaningful variable and function names
- Add JSDoc comments for complex functions
- Ensure components are accessible
Documentation
- Update README files as needed
- Add examples for new components
- Include prop tables and usage instructions
- Test all code examples
Types of Contributions Welcome
- ๐ Bug Fixes - Help us fix issues and improve stability
- โจ New Components - Add new billing and subscription components
- ๐ Documentation - Improve guides, examples, and API docs
- ๐จ Themes - Create new visual themes and variants
- ๐ง Developer Experience - Improve tooling and development workflow
- ๐งช Testing - Add tests and improve coverage
License & Usage
Billing SDK is released under the GNU General Public License (GPL), ensuring the project remains open and free:
- โ Use freely for any purpose
- โ Study and modify the source code
- โ Distribute copies to help others
- โ Distribute modified versions
- โ ๏ธ Must keep derivatives under GPL license
- โ ๏ธ Must provide source code when distributing
GPL License Benefits
The GPL license ensures that Billing SDK and all derivative works remain free and open source, protecting the commons and ensuring community benefits are preserved.
Project Links
GitHub Repository
View source code, report issues, and contribute
Issue Tracker
Report bugs and request features
Community & Support
Core Maintainers
The project is actively maintained by a team of developers at DodoPayments who are committed to keeping it up-to-date, secure, and feature-rich.
Community Support
- Issues & Bugs - Community-driven issue resolution
- Feature Requests - Prioritized based on community needs
- Documentation - Collaborative improvement of guides and examples
- Code Reviews - Peer review for quality assurance
Get Involved
- Join discussions in GitHub Issues
- Share your use cases and feedback
- Help answer questions from other users
- Suggest new features and improvements
Get Involved
Whether you're a seasoned developer or just getting started, there are many ways to contribute to the project and help make it better for everyone.
Roadmap
Our development is guided by community feedback and industry needs:
- ๐ฏ Short Term - Bug fixes, performance improvements, new component variants
- ๐ Medium Term - Advanced theming system, more component types, better accessibility
- ๐ Long Term - Framework integrations, design system expansion, enterprise features
Join us in building the future of billing components!
Learn More
New to here? Don't worry, we welcome your questions.
If you find anything confusing, please give your feedback on GitHub Issues!
Questions?
If you find anything confusing or need help getting started, please open an issue on GitHub Issues!
ShadCN CLI 3.0 Integration Guide
Comprehensive guide to integrating Billing SDK components using ShadCN CLI 3.0 with MCP support
Pricing Table One
The Pricing Table One component provides a clean and modern design for displaying pricing plans. You can use this component to display your pricing plans in a clean and modern way.