CONTRIBUTING
Contributing to AppKit
First off, thank you for taking the time to contribute! These guidelines are here so that we can review and merge changes quickly and keep the project healthy.
---
Before You Start
- Large changes? Talk to us first. If you are planning a significant feature or refactor, please open an Issue describing the proposal before you begin writing code. This helps everyone avoid duplicated effort and prevents disappointment if a large contribution is not aligned with the project roadmap.
- Small bug fixes & improvements can usually be submitted right away as pull requests.
Types of Contributions
| Contribution Type | Issue Needed? | Tests Required? |
| ----------------- | ------------------------ | ---------------------------------------------- |
| π Bug fix | Recommended | Yes (unit/integration) |
| β¨ New feature | Required | Yes (unit/integration + e2e if applicable) |
| π Docs update | Optional | N/A |
| π§Ή Refactor | Required for large scope | Yes |
| π§ͺ Test-only | Optional | N/A |
Quality Standards
Only highβquality, wellβtested contributions will be considered.
- Coding style must follow the project's linting rules (run pnpm prettier / etc.) and make CI green.
- Tests should cover new code paths and strive for edge cases.
- Performance: avoid regressions. If your change impacts performance, include benchmarks.
Submitting Changes
1. Fork the repository and create your branch: git checkout -b feature/my-amazing-feature.
2. Write code & tests. Ensure pnpm test (or equivalent) passes.
3. Keep commits focused. Squash or rebase interactively to group related changes.
4. Open a pull request against the main branch. Use the PR template to explain _what_ and _why_.
5. One or more maintainers will review. Be ready to iterate β friendly feedback helps us all learn.
6. When approved, your PR will be squashed and merged. π
License Agreement
By submitting a contribution, you agree that your code will be released under the project's license and that the project maintainers reserve the right to change the license in the future. If this is a concern, please raise it in the discussion phase _before_ contributing.
---
Thanks again for helping to make AppKit better!
---
README
AppKit
The full stack toolkit to build onchain app UX.
Onboard millions of users to your app in minutes with social & email embedded wallets, web3 wallet login, crypto swaps, on-ramp and more.
π Demo γ»π§ͺ Laboratory γ»π Documentation γ»π» AppKit Web Examples γ»π Website γ»π Contact us on Discord
<p align="center">
<img src="https://github.com/reown-com/appkit/blob/HEAD/.github/assets/header.png" alt="" border="0">
</p>
Features
Refer to the "Features" section of the AppKit docs.
- Swaps
- On-Ramp
- Multi Chain
- Multi Wallets
- Smart Accounts
- Telegram Mini Apps
- Sponsored Transactions
- Networks: EVM Chains, Solana, Bitcoin
- AppKit Core: Chain Agnostic
- Authentication: Email & Social Login, One-Click Auth & Sign with X (SIWX)
AppKit Available SDKs
- React
- Next
- Vue
- Nuxt
- Svelte
- Javascript
- React Native
- Flutter
- Android
- iOS
- Unity
If you are using Web3Modal v1βv5, please use our migration guides.
License and Use
This SDK is provided under the [Reown AppKit] Community License (βCommunity Licenseβ), that governs, among other things:
- Permitted non-commercial use
- RPC and MAU thresholds for commercial licensing
- Required connection to Reown's proprietary infrastructure
- Redistribution and attribution obligations
- Ownership of modifications
- Mandatory binding arbitration for disputes
Downloading, installation, integration and use of this SDK constitutes acceptance of the Reown AppKit Community License.
---