Contributing¶
Herald lives in these repositories:
| Repository | What's in it |
|---|---|
| herald | the Android SDK, and the Kotlin code shown on this site |
| herald-flutter | the Flutter SDK, and the Dart code shown on this site |
| herald-ios | the iOS SDK's core, and the Swift code shown on this site; each iOS vendor package has a repository of its own |
| herald-kmp | Kotlin Multiplatform, over the Android and iOS SDKs |
| herald-react-native | the React Native SDK, and the TypeScript code shown on this site |
| herald-docs | this website's pages |
Each has a CONTRIBUTING file with its rules: Android, Flutter, iOS, Kotlin Multiplatform, React Native and website.
Where a change goes¶
- A bug or a feature: the SDK's repository, with its tests.
- A code example: the SDK's samples:
docs-samplesfor Android,docs_samplesfor Flutter,Samplesin herald-ios, ordocs-samplesin herald-react-native. The SDK's build compiles them, so an example can't stop working without failing it. - The words on a page: herald-docs. Pages describe released versions only, so a page about a new feature merges once the feature is released.
To report a problem, open an issue on GitHub, for Android, Flutter, iOS, React Native or this website.