|
| 1 | +# Contributing to FlutterStripe |
| 2 | + |
| 3 | +We welcome contributions to FlutterStripe! Here are some guidelines to help you get started. |
| 4 | + |
| 5 | +## Discuss, ask questions about or disagree with changes in FlutterStripe |
| 6 | + |
| 7 | +* [FlutterStripe/discussions](https://github.com/flutter-stripe/flutter_stripe/discussions) is the place for community discussions around FlutterStripe. |
| 8 | +* Our issues and pull requests are for maintainers and contributors to discuss work to be done, not users or contributors asking questions about FlutterStripe usage or disagreeing with changes already made. |
| 9 | + |
| 10 | +## Report a bug |
| 11 | + |
| 12 | +* Make sure you are running the latest version of FlutterStripe. |
| 13 | +* Run and read `flutter doctor`. |
| 14 | +* Keep in mind that this is an open source project, so issues may not be prioritized. |
| 15 | +* Ideally, open a pull request to fix it, describing both your problem and your proposed solution. |
| 16 | +* If not,make sure that the issue complies to our [bug report template](https://github.com/flutter-stripe/flutter_stripe/blob/HEAD/.github/ISSUE_TEMPLATE/bug-report.md). |
| 17 | + |
| 18 | +## Propose a feature |
| 19 | + |
| 20 | +* Ideally, open a pull request to implement it, describing both the problem it solves for you and your proposed solution. |
| 21 | +* If not, create an issue that complies to our [feature request template](https://github.com/flutter-stripe/flutter_stripe/blob/HEAD/.github/ISSUE_TEMPLATE/feature_request.md). |
| 22 | +* Please note we may close this issue or ask you to create a pull request if this is not something we see as sufficiently high priority. |
| 23 | + |
| 24 | +## Developing |
| 25 | +### Setup |
| 26 | + |
| 27 | +This project uses [melos](https://github.com/invertase/melos) to manage all the packages inside this repo. |
| 28 | + |
| 29 | +- Install melos: `dart pub global activate melos` |
| 30 | +- Setup melos in your local folder: `melos bootstrap` |
| 31 | + |
| 32 | +### Code that should not be changed |
| 33 | +Our code is in sync with the [Stripe React Native SDK](https://github.com/stripe/stripe-react-native) we only maintain the Flutter bindings and the native code is a close copy of the Stripe native SDKs to ensure security and stability. Because of this we do not accept changes in the Stripe native SDK. The native sdk code is located in the `packages/stripe_android/android/src/main/kotlin/com/reactnativestripesdk` and `packages/stripe_ios/ios/stripe_ios/Sources/stripe_ios/Stripe Sdk` folders. |
| 34 | + |
| 35 | +### Useful commands |
| 36 | + |
| 37 | +- Format `melos run format` |
| 38 | +- Analyze `melos run analyze` |
| 39 | +- Test `melos run unittest` |
| 40 | +- Pub get `melos run get` |
| 41 | + |
| 42 | +##### Publishing |
| 43 | + |
| 44 | +- Use `melos version` and `melos publish` to keep all the repositories in sync |
| 45 | + |
| 46 | + |
| 47 | +## "Artificial Intelligence"/Large Language Model (AI/LLM) usage |
| 48 | + |
| 49 | +We allow you to create issues and pull requests with AI/LLM with the following requirements: |
| 50 | + |
| 51 | +* You must disclose in the initial issue or pull request that you used AI/LLM and what tool/model/etc. you used. |
| 52 | +* All issues must comply to our issues templates described above. |
| 53 | +* You must review all AI/LLM generated code, comments, and documentation before you ask anyone to review it for you. |
| 54 | +* You must be able to address all pull request review comments, manually if the AI/LLM cannot do so for you. |
| 55 | +* If you reach the point where you feel unwilling or unable to do the above, please close your issue or pull request. |
| 56 | + |
| 57 | +Thank you! |
0 commit comments