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

Commit f115c8e

Browse files
committed
docs: update contributing
1 parent 3de3149 commit f115c8e

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

.vscode/settings.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
"cSpell.words": [
4444
"billingclient",
4545
"gson",
46+
"hyodotdev",
4647
"openiap",
4748
"skus"
4849
]

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,13 @@ cd openiap-google
3333
adb shell am start -n dev.hyo.martie/.MainActivity
3434
```
3535

36+
## Generated Types
37+
38+
- All GraphQL models in `openiap/src/main/java/dev/hyo/openiap/Types.kt` are generated from the [`hyodotdev/openiap-gql`](https://github.com/hyodotdev/openiap-gql) repository. When you update API behavior, adjust the upstream type generator first so the Kotlin output stays in sync across platforms.
39+
- The canonical workflow is documented in `CONVENTION.md`. Read it before touching generated models or related helpers.
40+
- To refresh the generated file locally, run `./scripts/generate-types.sh`. If you need to experiment with manual edits, you can pass `--skip-download true` to reuse the current `Types.kt` while still applying the post-processing step, but remember that ad-hoc edits will not ship in published releases unless the upstream generator incorporates them.
41+
- For changes that require generator support, open an issue or pull request in the `openiap-gql` repository.
42+
3643
## Code Style
3744

3845
- Follow the official Kotlin Coding Conventions

0 commit comments

Comments
 (0)