Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

60 lines (42 loc) · 1.61 KB
Raw

Contributing

We welcome contributions! Whether it's bug fixes, feature improvements, or documentation updates, your help is appreciated.

This project follows the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

Commit Messages

We use Conventional Commits for clear communication and automated versioning. Please format your commit messages as follows:

type(scope): description

[optional body]
[optional footer]

Where type is one of:

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation changes
  • chore: Maintenance tasks
  • test: Adding or updating tests
  • refactor: Code changes that neither fix bugs nor add features

Development

This library is built with Nitro. After making changes to native code, you must run:

npm run codegen

This regenerates the necessary bindings between JavaScript and native code.

Working on the Example App

Install dependencies:

npm install

Then, follow these steps to run the app on iOS:

cd ./example && npm run ios

or on Android:

cd ./example && npm run android

You can also open the example project directly in Xcode (example/ios/NitroPlayground.xcworkspace) or Android Studio (example/android) for native development.

Make sure to run the WebSocket server in the background:

cd ./example && bun server.ts

Otherwise, the app will not be able to connect to the server and will fail with a connection error.