Skip to content

Latest commit

聽

History

History
39 lines (28 loc) 路 931 Bytes

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) 路 931 Bytes
Raw

Contribution Guide

Setup development environment

Install dependencies and run yarn start to watch TypeScript files.

yarn install

Development flow

  1. yarn start to fire up webpack watching and transpiling TypeScript files inside PolyglotSafariExtensinos/Sources.
  2. Open up Polyglot.xcodeproj in Xcode.
  3. Build and launch Polyglot target.
  4. In the Safari settings, ensure that Polyglot extension is enabled.
  5. Everytime you change .ts and .swift files, you will need to re-build the app (step 3) to reflect these changes.

Build a distributable package

make

Before commit

yarn build  # => build codebase to ensure there are no errors
yarn format # => format code with SwiftFormat

Release (Maintainers only)

VERSION=3.2 BUILD=0 node Scripts/update-version.js
git add .
git commit -m 'chore: release v3.2.0'
yarn ship:mas # for Mac App Store