Skip to content

Latest commit

 

History

History
162 lines (120 loc) · 3.4 KB

CONTRIBUTING.md

File metadata and controls

162 lines (120 loc) · 3.4 KB

Contributing to Tonkeeper Web

This document describes the development workflow and conventions used in this project.

Branch Naming

feature/<description>     — new features
fix/<description>         — bug fixes
hotfix/<description>      — urgent production fixes

Examples:

  • feature/wallet-connect-v2
  • fix/transaction-signing
  • fix/PRO-123-popup-issue
  • hotfix/critical-security-patch

Commit Messages

We use Conventional Commits format:

<type>(<scope>): <description>

Types:

  • feat — new feature
  • fix — bug fix
  • chore — maintenance (dependencies, release, etc.)
  • refactor — code refactoring
  • docs — documentation changes

Scopes (optional): desktop, extension, web, core, uikit, locales, mobile, twa

Examples:

feat(extension): add Firefox manifest v3 support
fix(desktop): resolve crash on large NFT collections
fix(PRO-123): transaction signing error
chore: update dependencies
chore: release 4.3.4

Development Workflow

1. Create a branch

git checkout main
git pull origin main
git checkout -b feature/my-feature

2. Make changes and commit

git add .
git commit -m "feat: add new feature"

3. Push and create a Pull Request

git push origin feature/my-feature
gh pr create --base main

Or create PR via GitHub UI.

4. CI Checks

When you open a PR, the following builds run automatically:

  • Desktop (Linux, Windows, macOS)
  • Web (preview deployment)
  • Extension (Chrome, Firefox)
  • iPad

5. Code Review and Merge

After approval, the PR is merged into main using merge commit.

Release Process

1. Update versions

Update version in the following files:

  • package.json (root)
  • apps/web/package.json
  • apps/desktop/package.json
  • apps/extension/package.json

2. Create release commit

git add .
git commit -m "chore: release X.Y.Z"

3. Create and push tag

git tag vX.Y.Z
git push origin main
git push origin vX.Y.Z

4. Automated deployment

Pushing a tag triggers the CD workflow which:

  • Builds and publishes Desktop apps to GitHub Release
  • Deploys Web app to production
  • Builds and uploads browser extensions
  • Uploads iPad build to TestFlight

Versioning

We use Semantic Versioning: MAJOR.MINOR.PATCH

  • PATCH — bug fixes (4.3.4 → 4.3.5)
  • MINOR — new features, backward compatible (4.3.4 → 4.4.0)
  • MAJOR — breaking changes (4.3.4 → 5.0.0)

All apps (web, desktop, extension) share the same version number.

Project Structure

tonkeeper-web/
├── apps/
│   ├── desktop/      — Electron desktop app
│   ├── extension/    — Browser extension (Chrome, Firefox)
│   ├── web/          — Web application
│   ├── mobile/       — Mobile/iPad app (Capacitor)
│   ├── twa/          — Telegram Web App
│   └── web-swap-widget/
├── packages/
│   ├── core/         — Core business logic
│   ├── uikit/        — UI components
│   └── locales/      — Translations
└── .github/
    └── workflows/    — CI/CD pipelines

Useful Commands

# Install dependencies
yarn install

# Build all packages
yarn build:pkg

# Run web app locally
yarn start:web

# Build for production
yarn build:web
yarn build:desktop
yarn build:extension