Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (43 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 1.33 KB
Raw

Contributing

Thanks for contributing to the Screeb SDKs!

Setup

git clone https://github.com/ScreebApp/sdk.git
cd sdk
npm install

Repository structure

Path Contents
packages/sdk-browser @screeb/sdk-browser — vanilla JS/TS
packages/sdk-angular @screeb/sdk-angular — Angular wrapper
packages/sdk-react @screeb/sdk-react — React wrapper
packages/sdk-reactnative @screeb/react-native — React Native
packages/sdk-flutter plugin_screeb — Flutter plugin
examples/ Demo apps (not published)

Build

npm run build              # all JS/TS packages
cd packages/sdk-flutter && flutter pub get && flutter build  # Flutter

Testing

npm test                   # JS/TS packages
cd packages/sdk-flutter && flutter test  # Flutter

Commit convention

We use Conventional Commits:

  • feat(sdk-browser): add X
  • fix(sdk-react): resolve Y
  • chore: update dependencies

Releasing

Each package is released independently. Releases are triggered by pushing a git tag:

# JS packages — use Lerna
npm run version

# Flutter
# 1. Bump version in packages/sdk-flutter/pubspec.yaml
git tag sdk-flutter/vX.Y.Z && git push --tags

# MAUI (NuGet)
git tag sdk-maui/v0.1.0 && git push --tags