Honeycomb React Native Development

Development guidelines and workflows for working with Honeycomb's OpenTelemetry distribution for React Native applications.

Core Principles

Test Integrity

Security and Git Safety

Code Quality Standards

Project Structure

```

ios/ # iOS Native Modules

android/ # Android Native Modules

example/ # Example application for testing

ios/ # iOS app source

android/ # Android app source

src/ # TypeScript source

e2e/ # Detox test files

src/plugin/ # Expo UUID plugin

smoke-tests/ # Smoke test suite

smoke-e2e.bats # Main smoke test file

test_helpers/ # Test utilities

utilities.bash

```

Development Commands

Testing

```bash

Unit tests

yarn test

Smoke tests

make smoke-ios # iOS smoke tests

make smoke-android # Android smoke tests

Code quality

make lint

make format

```

Build and Development

```bash

Launch example app

yarn example ios # Run iOS

yarn example android # Run Android

Open Xcode

xed example/ios

Regenerate native modules

yarn bob build --target codegen

```

Testing Strategy

1. **Manual Testing**

- Launch example app and ask human to verify functionality

- Use example app for exploratory testing of new features

2. **Smoke Testing**

- Time-consuming but comprehensive

- Launches Example App and runs Detox tests

- Most updates only require modifying `smoke-tests/smoke-e2e.bats`

- Detox tests located at `example/e2e/starter.test.ts`

Environment Configuration

Required Environment Variables

**ANDROID_HOME**

**JAVA_HOME**

Troubleshooting

`$ANDROID_HOME is not set`

Set environment variable: `export ANDROID_HOME=$HOME/Library/Android/sdk`

Also verify `JAVA_HOME` is configured

`$JAVA_HOME is not set`

Set environment variable: `export JAVA_HOME=/Applications/Android\ Studio.app/Contents/jbr/Contents/Home`

Also verify `ANDROID_HOME` is configured

Workflow Examples

Making Code Changes

1. Read existing code to understand patterns

2. Ask about business logic if unclear

3. Make targeted changes to specific files

4. Update `CHANGELOG.md`

5. Stage only modified files: `git add path/to/file.ts`

6. Run relevant tests

7. Create PR using template (remove non-applicable sections)

Adding New Features

1. Understand requirements and ask clarifying questions

2. Modify TypeScript source in `src/` or native modules in `ios/`/`android/`

3. Update example app in `example/src/` if needed to demonstrate feature

4. Regenerate native modules if JavaScript interfaces changed

5. Update `CHANGELOG.md` with feature description

6. Request manual testing from human

7. Update smoke tests in `smoke-tests/smoke-e2e.bats` if appropriate

Fixing Bugs

1. Reproduce issue in example app if possible

2. Identify root cause in library code

3. Fix in appropriate layer (TypeScript, iOS native, or Android native)

4. Update `CHANGELOG.md` with fix description

5. Add test coverage if gap identified (with permission)

6. Run smoke tests if time permits