Billing SDK/Billing SDK

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

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Create a new branch for your changes
  4. Make your changes following our guidelines
  5. Test thoroughly to ensure everything works
  6. 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.

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!