Skip to content
This repository was archived by the owner on Oct 16, 2025. It is now read-only.

Commit b1d5eff

Browse files
committed
docs: markdown lint
1 parent 886fd0b commit b1d5eff

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed

.markdownlint.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"default": true,
33
"MD013": false,
4+
"MD024": false,
45
"line-length": false,
56
"MD033": false,
67
"no-inline-html": false

CLAUDE.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
#### Examples
1212

1313
##### ✅ Correct
14+
1415
```swift
1516
// iOS-specific functions
1617
func presentCodeRedemptionSheetIOS()
@@ -29,6 +30,7 @@ func finishTransaction()
2930
```
3031

3132
##### ❌ Incorrect
33+
3234
```swift
3335
// Missing IOS suffix for iOS-specific
3436
func presentCodeRedemptionSheet() // Should be presentCodeRedemptionSheetIOS()
@@ -44,8 +46,9 @@ func requestPurchaseIOS() // Should be requestPurchase() if cross-platform
4446
- **Use exact same function names as React Native OpenIAP**
4547

4648
#### Standard API Names
49+
4750
- `initConnection()` - Initialize IAP connection
48-
- `endConnection()` - End IAP connection
51+
- `endConnection()` - End IAP connection
4952
- `fetchProducts()` - Fetch products from store
5053
- `getProducts()` - Get cached products
5154
- `getAvailablePurchases()` - Get available/restored purchases
@@ -84,7 +87,7 @@ func requestPurchaseIOS() // Should be requestPurchase() if cross-platform
8487
### Specific Cases
8588

8689
- **iOS**: `Ios` when at beginning/middle, `IOS` when as suffix
87-
- **IAP**: `Iap` when at beginning/middle, `IAP` when as suffix
90+
- **IAP**: `Iap` when at beginning/middle, `IAP` when as suffix
8891
- **API**: `Api` when at beginning/middle, `API` when as suffix
8992
- **URL**: `Url` when at beginning/middle, `URL` when as suffix
9093

@@ -99,6 +102,7 @@ func requestPurchaseIOS() // Should be requestPurchase() if cross-platform
99102
### Directory Structure
100103

101104
- **Sources/Models/**: OpenIAP official types that match [openiap.dev/docs/types](https://www.openiap.dev/docs/types)
105+
102106
- `Product.swift` - OpenIapProduct and related types
103107
- `Purchase.swift` - OpenIapPurchase and related types
104108
- `ActiveSubscription.swift` - ActiveSubscription type
@@ -107,6 +111,7 @@ func requestPurchaseIOS() // Should be requestPurchase() if cross-platform
107111
- etc.
108112

109113
- **Sources/Helpers/**: Internal helper classes (NOT in OpenIAP official types)
114+
110115
- `ProductManager.swift` - Thread-safe product caching
111116
- `IapStatus.swift` - UI status management for SwiftUI
112117

CONTRIBUTING.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ All new features must include tests:
5454
func testYourFeature() async throws {
5555
// Arrange
5656
let module = IapModule.shared
57-
57+
5858
// Act
5959
let result = try await module.yourMethod()
60-
60+
6161
// Assert
6262
XCTAssertEqual(result, expectedValue)
6363
}
@@ -93,17 +93,19 @@ Keep them clear and concise:
9393
When your PR is merged, maintainers will handle the release:
9494

9595
1. **Version Update**: We use semantic versioning (major.minor.patch)
96+
9697
```bash
9798
./scripts/bump-version.sh patch # for bug fixes
9899
./scripts/bump-version.sh minor # for new features
99100
./scripts/bump-version.sh major # for breaking changes
100101
```
101102

102103
2. **Automatic Deployment**: Creating a GitHub release triggers:
104+
103105
- Swift Package Manager update (immediate)
104106
- CocoaPods deployment (via `pod trunk push`)
105107

106-
3. **Availability**:
108+
3. **Availability**:
107109
- Swift Package: Available immediately after release
108110
- CocoaPods: Available within ~10 minutes via `pod update`
109111

@@ -112,6 +114,7 @@ Contributors don't need to worry about deployment - just focus on making great c
112114
## Questions?
113115

114116
Feel free to:
117+
115118
- Open an issue for bugs or features
116119
- Start a discussion for questions
117120
- Tag @hyodotdev for urgent matters

0 commit comments

Comments
 (0)