Improve contribution docs (#34)

Author: markmur

.github/actions/use-turbo-cache/action.yml

@@ -8,6 +8,6 @@ runs:
       uses: actions/cache@v3
       with:
         path: .turbo
-        key: turbo-${{ github.sha }}
+        key: ${{ runner.os }}-turbo-${{ github.sha }}
         restore-keys: |
-          turbo-
+          ${{ runner.os }}-turbo-

.github/workflows/ci.yml

@@ -65,8 +65,8 @@ jobs:
 
       - name: Check build cache
         run: |
-          CACHE_STATUS=$(./scripts/check_cache sample build:android)
-          echo "[sample] build:android - $CACHE_STATUS"
+          CACHE_STATUS=$(./scripts/check_cache sample test:android)
+          echo "[sample] test:android - $CACHE_STATUS"
           echo "turbo_cache_hit=$CACHE_STATUS" >> $GITHUB_ENV
 
       - name: Install JDK
@@ -93,7 +93,7 @@ jobs:
       - name: Run Android tests
         # If turbo has already cached the build it will return instantly here
         run: |
-          yarn turbo run test:android --cache-dir=".turbo"
+          yarn turbo run test:android --cache-dir=".turbo" --no-daemon
 
   test-ios:
     name: Run iOS Tests
@@ -120,7 +120,7 @@ jobs:
       - name: Install cocoapods
         uses: ./.github/actions/install-cocoapods
 
-      - name: Build sample for iOS
+      - name: Run Swift tests
         # If turbo has already cached the build it will return instantly here
         run: |
-          yarn turbo run test:ios --cache-dir=".turbo"
+          yarn turbo run test:ios --cache-dir=".turbo" --no-daemon

CONTRIBUTING.md

@@ -3,64 +3,96 @@
 This repo is subdivided into 3 parts using yarn workspaces:
 
 - The base repo (workspace name = `checkout-kit-react-native`)
-- The `react-native-shopify-checkout-kit` Native Module (workspace name = `module`)
+- The `react-native-shopify-checkout-kit` Native Module (workspace name =
+  `module`)
 - The sample application (workspace name = `sample`)
 
-Each of the worksapces contains a separate `package.json` to manage tasks specific to each workspace.
+Each of the worksapces contains a separate `package.json` to manage tasks
+specific to each workspace.
 
-## Base repo
+## Getting started
 
-## Install dependencies
+If you've cloned the repo and want to run the sample app, you will first need
+to:
 
-Run `yarn` to install the dependencies for all workspaces in the repo.
+1. Install the NPM dependencies
+2. Install iOS dependencies (cocoapods)
+3. Build the Native Module
 
----
-
-## `react-native-shopify-checkout-kit` Module
+```sh
+# Install NPM dependencies and link local module
+yarn
 
-### Clean the modules folder
+# Install Cocoapods for iOS
+yarn pod-install sample/ios
+# Note: Android dependencies are automatically installed by Gradle
 
-```bash
-yarn module clean
+# Build the Native Module JS
+yarn module build
 ```
 
-### Build the `react-native-shopify-checkout-kit` module
+If all of these steps have succeeded, you can now run the sample app with:
 
 ```sh
-yarn module build
+yarn sample start
 ```
 
-### Lint the module
+This command will start the Metro server. Follow the steps given by Metro to
+open both the iOS and Android simulators/emulators respectively.
 
-```sh
-yarn module lint
-```
+## Making changes to the Native Module
 
----
+If your intentions are to modify the TS code for the Native Module under
+`modules/react-native-shopify-checkout-kit`, note that you will not need to
+rebuild to observe your changes in the sample app. This is because the sample
+app is importing the TS files directly from the module directory (through
+symlinking).
 
-## Sample application
+However, if you're running the iOS/Android tests against the module, you will
+first need to run `yarn module build` each time you change the TS code.
 
-## Start the sample application
+## Cleaning the workspaces
 
-### For Android
+There are a handful of commands to clean the individual workspaces.
 
-```bash
-# Start the Metro server
-yarn sample start
+```sh
+# Clear the current directory from watchman
+yarn clean
 
-# Start the Metro server and run the Android sample application
-yarn sample android
+# Removes the "sample/node_modules" directory
+# Removes "ios/pods" directory
+# Removes "ios/build" directory
+yarn sample clean
 
-# Start the Metro server and run the iOS sample application
-yarn sample android
+# Removes the "lib" directory for the Native Module
+yarn module clean
 ```
 
-If everything is set up _correctly_, you should see your new app running in your _Android Emulator_ or _iOS Simulator_ shortly provided you have set up your emulator/simulator correctly.
-
-This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.
+## Linting the code
 
-## Lint the sample application
+Linting the codespaces will (1) compile the code with TypeScript and (2) run
+eslint over the source code.
 
 ```sh
+# Lint the Native Module TS code
+yarn module lint
+
+# Lint the Sample App TS code
 yarn sample lint
 ```
+
+## Testing
+
+There are 3 types of tests in this repo: Typescript, Swift and Java - each for
+testing the Native Module.
+
+```sh
+# Run Jest tests for "modules/react-native-shopify-checkout-kit/src/**/*.tsx"
+yarn test
+
+# Run swift tests for the Native Module
+yarn sample test:ios
+
+# Run Java tests for the Native Module
+yarn sample test:android
+```

sample/.eslintignore

@@ -0,0 +1,2 @@
+android/build
+android/app/build

sample/scripts/test_android

@@ -4,4 +4,4 @@ set -e
 
 cd android
 
-./gradlew test --no-daemon --console=plain -PreactNativeArchitectures=arm64-v8a
+./gradlew clean test --no-daemon --console=plain -PreactNativeArchitectures=arm64-v8a

turbo.json

@@ -2,11 +2,9 @@
   "$schema": "https://turbo.build/schema.json",
   "pipeline": {
     "build": {
-      "outputs": ["modules/react-native-shopify-checkout-kit/lib/**/*"]
-    },
-    "lint": {
-      "dependsOn": ["build"]
+      "outputs": ["./modules/react-native-shopify-checkout-kit/lib/**"]
     },
+    "lint": {},
     "build:android": {
       "dependsOn": ["build", "lint"],
       "outputs": ["sample/android/app/build"]