Stripe React Native 开发环境搭建与贡献指南
项目地址: https://gitcode.com/gh_mirrors/st/stripe-react-native 项目概述
Stripe React Native 是一个官方维护的 React Native 库，用于在移动应用中集成 Stripe 支付功能。它为开发者提供了 React Native 风格的 API，封装了 Stripe 的原生 SDK 功能。
开发环境配置
基础环境准备
要开始开发 Stripe React Native，首先需要配置以下环境：
- Node.js 环境（建议使用 LTS 版本）
- Yarn 包管理器
- React Native 开发环境
- iOS 开发需要 Xcode
- Android 开发需要 Android Studio
示例应用运行步骤
运行示例应用是了解项目结构和测试修改的最佳方式：
-
安装依赖：
yarn bootstrap这个命令会安装项目所需的所有依赖，包括 iOS 的 CocoaPods 依赖。
-
配置环境变量：
cp example/.env.example example/.env然后编辑
.env文件，填入必要的 Stripe 测试密钥。 -
启动示例应用：
- 在第一个终端启动开发服务器：
yarn example start:server - 在第二个终端启动 Metro 打包器：
yarn example start - 在第三个终端根据目标平台运行：
yarn example ios # iOS 平台或
yarn example android # Android 平台
- 在第一个终端启动开发服务器：
代码编辑与调试
不同平台的代码位置
-
iOS 原生代码： 在 Xcode 中打开
example/ios/StripeSdkExample.xcworkspace，原生代码位于Pods > Development Pods > stripe-react-native路径下。 -
Android 原生代码： 在 Android Studio 中打开
example/android目录，原生代码位于reactnativestripesdk模块下。 -
TypeScript 代码： 可以直接在
src/和example/目录下编辑，使用你喜欢的代码编辑器。
代码质量保证
在提交代码前，确保通过以下检查：
-
类型检查：
yarn typescript -
代码风格检查：
yarn lint -
自动修复格式问题：
yarn lint --fix
测试策略
端到端测试
项目使用 Maestro 进行端到端测试，测试用例位于 e2e-tests/ 目录下。运行测试的步骤：
- 安装 Maestro 并配置环境
- 启动示例应用：
yarn run-example-ios # iOS yarn run-example-android # Android - 运行所有测试：
yarn test:e2e:ios # iOS yarn test:e2e:android # Android - 运行单个测试文件：
yarn test-ios ./path/to/testFile.yml yarn test-android ./path/to/testFile.yml
开发工作流
本地包管理
在开发过程中，你可能需要在其他项目中测试你的修改。推荐使用 yalc 工具：
- 发布本地包：
yalc publish - 在依赖项目中添加本地包：
yalc add @stripe/stripe-react-native - 安装依赖：
yarn install cd ios && pod install
提交规范
项目遵循约定式提交规范，提交信息应包含以下前缀之一：
fix: 修复 bugfeat: 新功能refactor: 代码重构docs: 文档变更test: 测试相关chore: 工具或配置变更
预提交钩子会自动验证提交信息格式。
实用脚本
项目提供了多个便捷脚本：
yarn bootstrap: 初始化项目，安装所有依赖yarn typescript: 运行 TypeScript 类型检查yarn lint: 运行 ESLint 检查yarn test: 运行 Jest 单元测试yarn example start: 启动示例应用的 Metro 服务器yarn example android: 在 Android 上运行示例应用yarn example ios: 在 iOS 上运行示例应用
最佳实践
- 保持提交小而专注：每个提交/拉取请求应该只解决一个问题或实现一个功能。
- 充分测试：确保你的修改通过了所有测试，包括新增的测试用例。
- 文档更新：如果修改了 API 或功能行为，记得更新相关文档。
- 预先讨论：对于重大变更，建议先创建 issue 与维护者讨论。
通过遵循这些指南，你可以更高效地为 Stripe React Native 项目做出贡献，同时确保代码质量和项目一致性。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
