@momo-kits/native-kits 0.152.4-beta.9 → 0.152.4-klib.10

package/README.md

@@ -1,7 +1,177 @@
-## 🛠 Installation
-### Using Cocoapods
-Add it inside your `Podfile`.
-```ruby
-pod 'MoMoUIKits', '../node_modules/@momo-platform/native-kits/ios'
+## ComposeKit (Kotlin Multiplatform)
+
+ComposeKit là bộ UI Kit đa nền tảng phục vụ Mini App/SDK của MoMo. Toàn bộ giao diện, điều hướng, token thiết kế và layer tích hợp với MaxAPI đều được viết bằng Kotlin Multiplatform để tái sử dụng cho Android, iOS (qua Compose Multiplatform) cũng như các host native.
+
+### Mục tiêu & phạm vi
+- Chuẩn hoá visual language của MoMo với kho component Compose đã mang sẵn màu sắc, typography, spacing, radius trong `vn.momo.compose.kit.const`.
+- Cung cấp navigation stack thống nhất (`NavigationContainer`, `Navigator`, bottom tabs, modal/bottom sheet) hỗ trợ dynamic screen registry và MaxAPI dismiss/present.
+- Cho phép host nhận context Mini App (`MiniAppContext`, `KitConfig`, `ApplicationContext`, `AppLanguage`) để tự động render Trust Banner, header assets, tracking.
+- Đồng bộ hoá với native SwiftUI kit (`nativeSDK/ios`) nhằm cover các màn đang viết Swift/Objective‑C.
+
+---
+
+### Cấu trúc thư mục
+- `shared/`: module KMP chính. Chứa toàn bộ source `vn.momo.compose.kit.*`, compose resources (font SF Pro), logic publish Maven và podspec.
+- `composeApp/`: sample Compose Multiplatform Android dùng để thử nhanh component, navigator, trust banner.
+- `iosApp/`: project SwiftUI + CocoaPods để test framework iOS sinh ra từ `shared`.
+- `nativeSDK/ios/`: Swift package + podspec `MoMoUIKits` (phụ thuộc `SDWebImageSwiftUI`, `SkeletonUI`) cho các màn hoàn toàn native.
+- `publish_release.sh`, `.gitlab-ci.yml`: script tự bump patch version, chạy `:compose:publish...` khi commit có `[ci build]`.
+- `build-output/`, `build/`: output tạm thời (không commit).
+
+---
+
+### Thành phần chính trong `shared`
+
+**Design tokens & theming**
+- `const/Colors.kt`, `Radius.kt`, `Spacing.kt`, `Typography.kt` định nghĩa token thống nhất.
+- `const/Theme.kt` cung cấp `Theme`, `ColorScheme`, `AppTheme`, `AppThemeController`. Có sẵn `defaultTheme` & `darkTheme`, hỗ trợ inject assets (vd. header background từ `KitConfig`).
+
+**Layout primitives & modifier**
+- `layout/Card.kt`, `Section.kt`, `Item.kt` chứa khung section theo guideline Super App.
+- `modifier/AutomationId`, `Conditional`, `Shadow`, `Size` giúp thêm accessibility id, điều kiện hoá modifier, shadow blur tuỳ nền.
+
+**UI components**
+- Buttons (`Button.kt`, `IconButton.kt`), typography helper (`Text.kt`, `Title.kt`), badge/tag (`Badge*`, `Tag.kt`), chip & switch (`Chip.kt`, `Switch.kt`), checkbox/radio.
+- Input stack: `Input*` (OTP, PhoneNumber, Money, Search, DropDown, TextArea) với keyboard helpers.
+- Pagination indicator (`PaginationDot/Number/Scroll/WhiteDot.kt`), skeleton loading (`Skeleton.kt`), trust UI (`TrustBanner.kt`).
+- Popup/notify (`PopupNotify`, `PopupPromotion`), floating button, `LazyColumnWithBouncing`, Cupertino overscroll, `DateTimePicker` (Wheel UI + utils).
+- Lottie animation (`components/animation/LottieAnimation`) dựng trên [Compottie](https://github.com/alexzhirkevich/compottie) để chạy animation JSON đồng nhất trên Android/iOS/Desktop.
+
+**Navigation & application layer**
+- `navigation/NavigationContainer`, `Navigation.kt`, `Navigator.kt`, `StackScreen.kt`, `BottomSheet.kt`, bottom tab helpers.
+- `Navigator` hỗ trợ `push`, `replace`, `present`, `reset`, `pop(count)`, `showModal`, `showBottomSheet` với overlay registry (`OverplayComponentRegistry`).
+- `application/NavigationContainer.kt`, `MiniAppContext`, `KitConfig`, `ApplicationContext`, `AppConfig`, `AppLanguage` cung cấp context cho header/trust banner, mapping sang map để gửi qua MaxAPI.
+- `application/Screen.kt`, `Header*`, `Footer`, `FloatingButton` tạo template screen (đang deprecate, khuyến nghị dùng `NavigationContainer + StackScreen`).
+
+**Platform utilities**
+- `platform/Platform.kt` định nghĩa expect/actual cho `getPlatformName`, `BackHandler`, `getScreenHeight`, `NativePaint` mask filter. Android actual đi kèm `getAndroidBuildVersion`.
+- `utils/Icons.kt`, `Resources.kt`, `getAppStatusBarHeight()` giúp truy xuất resource Compose đa nền tảng.
+
+**Native bridge**
+- `shared/shared.podspec` và `nativeSDK/ios/MoMoUIKits.podspec` cho phép embed vào iOS app via CocoaPods (deployment target 15.0, Swift 5). Phần native duy trì các SwiftUI component tương đương Compose (Button, Input, Popup, Trust Banner, Badge...).
+
+---
+
+### Yêu cầu môi trường
+- JDK 17+, Gradle 8, Android Studio Hedgehog+ với Android SDK (compileSdk xem `libs.versions.toml`).
+- Kotlin Multiplatform plugin + Compose Multiplatform (JetBrains 1.6.1+).
+- Xcode 15, CocoaPods 1.12+ để build `iosApp` hoặc publish Pod.
+- Truy cập mạng nội bộ GitLab Packages nếu cần publish/consume Maven repo `https://gitlab.mservice.com.vn/api/v4/projects/5400/packages/maven`.
+
+---
+
+### Build & kiểm thử nhanh
+
+| Tác vụ | Lệnh |
+| --- | --- |
+| Build thư viện KMP (AAR + klib + framework) | `./gradlew :compose:assembleRelease` |
+| Publish local maven (nếu cần thử) | `./gradlew :compose:publishAllPublicationsToMavenLocal` |
+| Sample Android | `./gradlew :composeApp:assembleDebug` |
+| Sample iOS | mở `iosApp/iosApp.xcworkspace` rồi build trên Xcode |
+
+Output Compose nằm trong `shared/build/outputs` và `shared/build/publications/*`. Debug fonts/resources ở `shared/src/commonMain/composeResources`.
+
+---
+
+### Publish nội bộ (GitLab Packages)
+1. Cập nhật `gradle.properties` nếu thay đổi group/artifact/version. Mặc định:
+   ```
+   name=ComposeKit
+   group=vn.momo.kits
+   artifact.id=kits
+   version=0.1.2
+   url=https://gitlab.mservice.com.vn/api/v4/projects/5400/packages/maven
+   gitlab.user=upload_packages
+   gitlab.password=<token>
+   ```
+2. Chạy `./publish_release.sh`. Script sẽ:
+   - Đọc version hiện tại, query các version đã publish qua GitLab API.
+   - Bump patch (`X.Y.Z+1`) đến khi không trùng.
+   - Ghi lại `gradle.properties`, export `VERSION`, chạy `./gradlew clean` + `:compose:publishAllPublicationsToGitLabPackagesRepository`.
+3. CI (`.gitlab-ci.yml`) tự động thực thi script này khi push với commit message chứa `[ci build]` (trừ khi branch khớp `engine/w*`).
+
+---
+
+### Tích hợp ComposeKit trong dự án KMP/Android
+
+**Thêm dependency**
+```kotlin
+repositories {
+    maven { url = uri("https://gitlab.mservice.com.vn/api/v4/projects/5400/packages/maven") }
+}
+
+commonMain.dependencies {
+    implementation("vn.momo.kits:kits:<version>")
+}
+```
+
+**Khởi tạo navigation container**
+```kotlin
+val miniAppContext = MiniAppContext(appId = "...", appCode = "...", appIcon = "...", toolkitConfig = ...)
+
+NavigationContainer(
+    initialScreen = { StackScreenExample() },
+    options = NavigationOptions(headerTitle = HeaderTitle.Default("Home")),
+    applicationContext = miniAppContext,
+    config = KitConfig(trustBanner = defaultBanner),
+    maxApi = maxApi, // IMaxApi implementation từ host
+    setNavigator = { navigator = it }
+)
+```
+
+Bên trong screen, truy cập `LocalNavigator.current` để:
+```kotlin
+val navigator = LocalNavigator.current
+navigator.push { DetailScreen() }
+navigator.showBottomSheet(content = { BottomSheetContent() })
+```
+
+Tuỳ biến theme bằng `AppThemeController`:
+```kotlin
+val themeController = AppThemeController.current
+themeController(defaultTheme.copy(colors = defaultTheme.colors.copy(primary = Colors.pink_04)))
+```
+
+`ApplicationContext.current`, `AppConfig.current`, `AppLanguage.current` giúp component (ví dụ `TrustBanner`) tự lấy dữ liệu trust banner và tracking `service_component_clicked`.
+
+---
+
+### Tích hợp iOS / Native SDK
+- `shared/shared.podspec` sinh framework Compose (static) mang tên theo `artifact.id` (`kits`). Add vào Podfile:
+  ```ruby
+  pod 'kits', :path => '../shared'
+  ```
+- Với màn SwiftUI thuần native, dùng `nativeSDK/ios`:
+  ```ruby
+  pod 'MoMoUIKits', :path => 'nativeSDK/ios'
+  ```
+  Bộ này mirror hầu hết component Compose (Button, Input, Popup, TrustBanner...). `ApplicationEnvironment` chấp nhận `MiniAppContext`, `KitConfig` tương tự Kotlin.
+
+---
+
+### Lưu ý khác
+- `Screen` composable cũ được đánh dấu `@Deprecated`; sử dụng `NavigationContainer + StackScreen` để hưởng lợi dynamic route và animation.
+- `DesignSystemWhiteList` trong `application/ApplicationContainer.kt` hỗ trợ fallback cho host cũ; đừng kích hoạt nếu không cần.
+- Khi thêm tài nguyên mới, đặt trong `shared/src/commonMain/composeResources` để Compose Multiplatform plugin sinh accessor tự động.
+- Repo không bundle SDK bên thứ ba ngoại trừ `vn.momo.corex.maxapi`, Compose/Coil/Ktor **và Compottie** cho animation.
+
+---
+
+### Animation Lottie đa nền tảng với Compottie
+
+```kotlin
+import io.github.alexzhirkevich.compottie.LottieCompositionSpec
+import vn.momo.kits.components.animation.LottieAnimation
+
+@Composable
+fun SuccessState() {
+    LottieAnimation(
+        spec = LottieCompositionSpec.Url(
+            "https://assets10.lottiefiles.com/packages/lf20_jcikwtux.json"
+        )
+    )
+}
 ```
 
+- `shared/build.gradle.kts` đã bật `coreLibraryDesugaringEnabled` để tương thích `compottie-dot`/`compottie-network` với `minSdk = 24`.
+- Nếu animation dùng asset/font nội bộ, kết hợp `compottie-resources` (`rememberResourcesAssetsManager`, `rememberResourcesFontManager`) để trỏ về `composeResources`.

package/ios/Badge/Badge.swift

@@ -64,12 +64,6 @@ public struct Badge: View {
                     .stroke(Colors.black01, lineWidth: 1)
             )
     }
-    
-    // Helper function for scaling sizes
-    // TODO: Implement proper scaling logic based on your design system
-    private func scaleSize(_ size: CGFloat) -> CGFloat {
-        return size
-    }
 }
 
 // MARK: - Preview

package/ios/Badge/BadgeRibbon.swift

@@ -1,5 +1,74 @@
 import SwiftUI
 
+// MARK: - Custom Shape for Rounded Corners
+struct RoundedCorners: Shape {
+    var topLeft: CGFloat = 0.0
+    var topRight: CGFloat = 0.0
+    var bottomLeft: CGFloat = 0.0
+    var bottomRight: CGFloat = 0.0
+    
+    func path(in rect: CGRect) -> Path {
+        var path = Path()
+        
+        let width = rect.size.width
+        let height = rect.size.height
+        
+        // Start from top left
+        path.move(to: CGPoint(x: topLeft, y: 0))
+        
+        // Top edge and top right corner
+        path.addLine(to: CGPoint(x: width - topRight, y: 0))
+        if topRight > 0 {
+            path.addArc(
+                center: CGPoint(x: width - topRight, y: topRight),
+                radius: topRight,
+                startAngle: Angle(degrees: -90),
+                endAngle: Angle(degrees: 0),
+                clockwise: false
+            )
+        }
+        
+        // Right edge and bottom right corner
+        path.addLine(to: CGPoint(x: width, y: height - bottomRight))
+        if bottomRight > 0 {
+            path.addArc(
+                center: CGPoint(x: width - bottomRight, y: height - bottomRight),
+                radius: bottomRight,
+                startAngle: Angle(degrees: 0),
+                endAngle: Angle(degrees: 90),
+                clockwise: false
+            )
+        }
+        
+        // Bottom edge and bottom left corner
+        path.addLine(to: CGPoint(x: bottomLeft, y: height))
+        if bottomLeft > 0 {
+            path.addArc(
+                center: CGPoint(x: bottomLeft, y: height - bottomLeft),
+                radius: bottomLeft,
+                startAngle: Angle(degrees: 90),
+                endAngle: Angle(degrees: 180),
+                clockwise: false
+            )
+        }
+        
+        // Left edge and top left corner
+        path.addLine(to: CGPoint(x: 0, y: topLeft))
+        if topLeft > 0 {
+            path.addArc(
+                center: CGPoint(x: topLeft, y: topLeft),
+                radius: topLeft,
+                startAngle: Angle(degrees: 180),
+                endAngle: Angle(degrees: 270),
+                clockwise: false
+            )
+        }
+        
+        path.closeSubpath()
+        return path
+    }
+}
+
 public enum RibbonPosition {
     case topLeft
     case topRight
@@ -76,14 +145,13 @@ public struct BadgeRibbon: View {
         .frame(height: RibbonConstants.roundHeight)
         .padding(.trailing, RibbonConstants.roundPaddingEnd)
         .background(
-            RoundedRectangle(cornerRadius: Radius.M)
-                .fill(backgroundColor)
-                .mask(
-                    HStack(spacing: 0) {
-                        Rectangle()
-                        RoundedRectangle(cornerRadius: Radius.M)
-                    }
-                )
+            RoundedCorners(
+                topLeft: 0,
+                topRight: RibbonConstants.roundRightRadius,
+                bottomLeft: 0,
+                bottomRight: RibbonConstants.roundRightRadius
+            )
+            .fill(backgroundColor)
         )
     }
     
@@ -139,7 +207,7 @@ private struct RibbonConstants {
     static let ribbonHeight: CGFloat = 20
     static let roundHeight: CGFloat = 16
     static let skewBodyHeight: CGFloat = 16
-    static let roundRightRadius: CGFloat = 12
+    static let roundRightRadius: CGFloat = 8
     static let roundPaddingEnd: CGFloat = 6
     static let skewTailWidth: CGFloat = 8
     static let skewTailHeight: CGFloat = 16

package/ios/Button/Button.swift

@@ -1,6 +1,6 @@
 import Foundation
-import SwiftUI
 import Lottie
+import SwiftUI
 
 // MARK: - ButtonType
 
@@ -33,7 +33,7 @@ public extension ButtonType {
     func backgroundColor(loading: Bool) -> Color {
         switch self {
         case .disabled: return Colors.black05.opacity(loading ? 0.75 : 1)
-        case .primary:  return Colors.primary.opacity(loading ? 0.75 : 1)
+        case .primary: return Colors.primary.opacity(loading ? 0.75 : 1)
         case .secondary: return Colors.card.opacity(loading ? 0.75 : 1)
         case .outline: return Colors.card.opacity(loading ? 0.75 : 1)
         case .tonal: return Colors.primaryLight.opacity(loading ? 0.75 : 1)
@@ -116,13 +116,13 @@ extension ButtonSize {
 }
 
 public struct Button: View {
-
     var title: String
     var action: () -> Void
     var type: ButtonType
     var size: ButtonSize
     var iconLeft: AnyView?
     var iconRight: AnyView?
+    var isFull: Bool
     var loading: Bool
 
     public init(
@@ -132,6 +132,7 @@ public struct Button: View {
         size: ButtonSize = .large,
         iconLeft: AnyView? = nil,
         iconRight: AnyView? = nil,
+        isFull: Bool = true,
         loading: Bool = false
     ) {
         self.title = title
@@ -140,6 +141,7 @@ public struct Button: View {
         self.size = size
         self.iconLeft = iconLeft
         self.iconRight = iconRight
+        self.isFull = isFull
         self.loading = loading
     }
 
@@ -156,7 +158,6 @@ public struct Button: View {
     }
 
     public var body: some View {
-
         let loadingOnLeft = shouldLoadingOnLeft(iconLeft, iconRight)
 
         let bg = type.backgroundColor(loading: loading)
@@ -165,12 +166,11 @@ public struct Button: View {
         let borderWidth = type.borderWidth
 
         SwiftUI.Button(action: {
-            if !loading && type != .disabled {
+            if !loading, type != .disabled {
                 action()
             }
         }) {
             HStack(spacing: size.iconSpacing) {
-
                 if loading && loadingOnLeft {
                     LottieView(name: "lottie_circle_loader", loopMode: .loop)
                         .frame(width: size.iconSize, height: size.iconSize)
@@ -195,7 +195,7 @@ public struct Button: View {
                     iconRight.frame(width: size.iconSize, height: size.iconSize)
                 }
             }
-            .frame(maxWidth: .infinity)
+            .frame(maxWidth: isFull ? .infinity : nil)
             .padding(.horizontal, size.padding)
             .frame(height: size.height)
             .background(bg)

package/ios/native-kits.podspec

@@ -1,18 +1,20 @@
-Pod::Spec.new do |spec|
-    spec.name          = 'MoMoUIKits'
-    spec.version       = '1.0.0'
-    spec.license       = { :type => 'MIT', :file => 'LICENSE' }
-    spec.homepage      = 'https://gitlab.com'
-    spec.authors       = { 'Developer' => 'momo@mservice.com.vn' }
-    spec.summary       = 'Components for SwiftUI'
-    spec.source        = { :git => 'https://gitlab.com', :tag => 'v1.0.0' }
-    spec.swift_versions = ['5.0']
-    spec.ios.deployment_target  = '13.0'
+Pod::Spec.new do |s|
+  s.name             = 'MoMoUIKits'
+  s.version          = '1.0.0'
+  s.summary          = 'MoMoUIKits for iOS'
+  s.homepage         = 'https://momo.vn'
+  s.license          = { :type => 'MIT', :file => 'LICENSE' }
+  s.author           = { 'MoMo' => 'dev@momo.vn' }
+  s.source           = { :path => '.' }
+
+  s.ios.deployment_target = '15.0'
+  s.swift_version         = '5.0'
+
+  s.source_files       = "**/*.swift"
+  s.framework             = 'SwiftUI', 'Combine'
+  s.dependency  'SDWebImageSwiftUI'
+  s.dependency       'lottie-ios'
+  s.dependency  'SkeletonUI', '1.0.11'
+end
 
-    spec.source_files   = "**/*.swift"
 
-    spec.framework      = 'SwiftUI', 'Combine'
-    spec.dependency       'SDWebImageSwiftUI'
-    spec.dependency       'lottie-ios'
-    spec.dependency       'SkeletonUI', '1.0.11'
-  end

package/package.json

@@ -1,10 +1,8 @@
 {
   "name": "@momo-kits/native-kits",
-  "version": "0.152.4-beta.9",
+  "version": "0.152.4-klib.10",
   "private": false,
-  "dependencies": {
-    "@momo-platform/native-max-api": "1.0.18"
-  },
+  "dependencies": {},
   "devDependencies": {},
   "license": "MoMo"
 }

package/CODE_OF_CONDUCT.md

@@ -1,133 +0,0 @@
-
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

package/CONTRIBUTING.md

@@ -1,114 +0,0 @@
-# Contributing
-
-Contributions are always welcome, no matter how large or small!
-
-We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the [code of conduct](./CODE_OF_CONDUCT.md).
-
-## Development workflow
-
-To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
-
-```sh
-yarn
-```
-
-> While it's possible to use [`npm`](https://github.com/npm/cli), the tooling is built around [`yarn`](https://classic.yarnpkg.com/), so you'll have an easier time if you use `yarn` for development.
-
-While developing, you can run the [example app](/example/) to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app.
-
-To start the packager:
-
-```sh
-yarn example start
-```
-
-To run the example app on Android:
-
-```sh
-yarn example android
-```
-
-To run the example app on iOS:
-
-```sh
-yarn example ios
-```
-
-Make sure your code passes TypeScript and ESLint. Run the following to verify:
-
-```sh
-yarn typecheck
-yarn lint
-```
-
-To fix formatting errors, run the following:
-
-```sh
-yarn lint --fix
-```
-
-Remember to add tests for your change if possible. Run the unit tests by:
-
-```sh
-yarn test
-```
-
-To edit the Objective-C or Swift files, open `example/ios/NativeKitsExample.xcworkspace` in XCode and find the source files at `Pods > Development Pods > @momo-platform/native-kits`.
-
-To edit the Java or Kotlin files, open `example/android` in Android studio and find the source files at `momo-platform-native-kits` under `Android`.
-
-
-### Commit message convention
-
-We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:
-
-- `fix`: bug fixes, e.g. fix crash due to deprecated method.
-- `feat`: new features, e.g. add new method to the module.
-- `refactor`: code refactor, e.g. migrate from class components to hooks.
-- `docs`: changes into documentation, e.g. add usage example for the module..
-- `test`: adding or updating tests, e.g. add integration tests using detox.
-- `chore`: tooling changes, e.g. change CI config.
-
-Our pre-commit hooks verify that your commit message matches this format when committing.
-
-### Linting and tests
-
-[ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/)
-
-We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint](https://eslint.org/) with [Prettier](https://prettier.io/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing.
-
-Our pre-commit hooks verify that the linter and tests pass when committing.
-
-### Publishing to npm
-
-We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.
-
-To publish new versions, run the following:
-
-```sh
-yarn release
-```
-
-### Scripts
-
-The `package.json` file contains various scripts for common tasks:
-
-- `yarn bootstrap`: setup project by installing all dependencies and pods.
-- `yarn typecheck`: type-check files with TypeScript.
-- `yarn lint`: lint files with ESLint.
-- `yarn test`: run unit tests with Jest.
-- `yarn example start`: start the Metro server for the example app.
-- `yarn example android`: run the example app on Android.
-- `yarn example ios`: run the example app on iOS.
-
-### Sending a pull request
-
-> **Working on your first pull request?** You can learn how from this _free_ series: [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).
-
-When you're sending a pull request:
-
-- Prefer small pull requests focused on one change.
-- Verify that linters and tests are passing.
-- Review the documentation to make sure it looks good.
-- Follow the pull request template when opening a pull request.
-- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.