Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
134 lines (99 loc) · 4.94 KB

CONTRIBUTING.md

File metadata and controls

134 lines (99 loc) · 4.94 KB

Contributing

We welcome contributions! This guide will help you get started with development setup and understanding the project structure.

Development Setup

  1. Clone and Install Dependencies

    git clone https://github.com/hyodotdev/openiap.git
cd openiap/libraries/react-native-iap
yarn install

  2. Generate Nitro Files

    yarn specs

  3. Running the Example App

    cd example && yarn ios
cd example && yarn android

Example Apps Architecture

This project includes one React Native CLI example application:

example/ - React Native CLI Example

  • Location: example/screens/
  • Router: React Navigation
  • Package Manager: Yarn (workspace)
  • Purpose: Main development and testing environment

Code Guidelines

  • Run yarn typecheck and yarn lint --fix before committing
  • Use TypeScript with strict mode
  • Follow existing code style and conventions
  • Add tests for new features when possible

Development Workflow

When working with example screens:

  1. Modify Source Files: Make changes in example/screens/*.tsx
  2. Test React Native: Run cd example && yarn ios/android to test changes
  3. Commit: Commit the source files in example/screens/

Testing

Before submitting changes:

# Check TypeScript and linting
yarn typecheck && yarn lint --fix

# Run library tests
yarn test:ci

# Test example apps
cd example && yarn test

Release Process (Maintainers)

Follow these steps when preparing a new release (e.g., 14.2.0):

  1. Verify CI locally

    yarn ci:check
# or:
yarn typecheck && yarn lint --fix && yarn test:ci && yarn nitrogen

  2. iOS/OpenIAP

    • Ensure Nitro codegen is up to date: yarn nitrogen
    • Verify Pods resolve in the example app: cd example/ios && pod install

  3. Android

    • We ship consumer R8 keep rules in android/consumer-rules.pro so Nitro classes aren’t stripped.
    • Verify a release build of the example app: cd example/android && ./gradlew :app:assembleRelease

  4. Version bump & docs

    • Update package.json version
    • Add a blog post in docs/blog/ with highlights
    • Update CHANGELOG if needed

  5. Tagging and Publishing

    • Push the release PR; ensure CI is green
    • Create a GitHub Release
    • Publish to npm via the existing workflows

Project Structure

  • android/: All your android-specific implementations.
    • build.gradle: The gradle build file. This contains four important pieces:
      1. Standard react-native library boilerplate code
      2. Configures Kotlin (apply plugin: 'org.jetbrains.kotlin.android')
      3. Adds all Nitrogen files (apply from: '.../NitroIap+autolinking.gradle')
      4. Triggers the native C++ build (via CMake/externalNativeBuild)
    • CMakeLists.txt: The CMake build file to build C++ code. This contains four important pieces:
      1. Creates a library called NitroIap (same as in nitro.json)
      2. Adds all Nitrogen files (include(.../NitroIap+autolinking.cmake))
      3. Adds all custom C++ files (only HybridTestObjectCpp.cpp)
      4. Adds a cpp-adapter.cpp file, which autolinks all C++ HybridObjects (only HybridTestObjectCpp)
    • src/main/java/com/margelo/nitro/iap/: All Kotlin implementations.
      • NitroIapPackage.java: The react-native package. You need this because the react-native CLI only adds libraries if they have a *Package.java file. In here, you can autolink all Kotlin HybridObjects.
  • cpp/: All your cross-platform implementations. (only HybridTestObjectCpp.cpp)
  • ios/: All your iOS-specific implementations.
  • nitrogen/: All files generated by nitrogen. You should commit this folder to git.
  • src/: The TypeScript codebase. This defines all HybridObjects and loads them at runtime.
    • specs/: All HybridObject types. Nitrogen will run on all *.nitro.ts files.
  • nitro.json: The configuration file for nitrogen. This will define all native namespaces, as well as the library name.
  • NitroIap.podspec: The iOS podspec build file to build the iOS code. This contains three important pieces:
    1. Specifies the Pod's name. This must be identical to the name specified in nitro.json.
    2. Adds all of your .swift or .cpp files (implementations).
    3. Adds all Nitrogen files (add_nitrogen_files(s))
  • package.json: The npm package.json file. react-native-nitro-modules should be a peerDependency.

Submitting Pull Requests

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run tests and linting: yarn typecheck && yarn lint --fix
  5. Submit a pull request with a clear description

For detailed usage examples and error handling, see the documentation.