Skip to content

Latest commit

 

History

History
124 lines (86 loc) · 3 KB

DEVELOPING.adoc

File metadata and controls

124 lines (86 loc) · 3 KB
Raw

Developing

Guide for our development process, project setup and how to write code.

Table Of Contents

Installation

Install Java & Kotlin

You could use Homebrew to install on mac

brew tap adoptopenjdk/openjdk
brew install adoptopenjdk11
brew install kotlin

OR The easiest way to install Java and Kotlin is to use SDK MAN

Just open your terminal and enter:

curl -s "https://get.sdkman.io" | bash

Follow the setup instructions and verify that your installation works:

sdk version

If it shows you something like 5.11.5+713 then your good to continue.

Just install the mentioned dependencies:

sdk install java 11.0.11.hs-adpt
sdk install kotlin 1.5.21

Check your installation by:

java -version
kotlin -version

Android Studio

For better interop with iOS you may install the Kotlin Multiplaform Mobile (KMM) plugin for Android Studio. It let’s you run, test and debug shared code on Android and iOS without switching the IDEs.

Development Process

Features

Every change has to branch of from main and use this branch naming convention:

  • feature/{type_of_change}-{short_description} or with ticket id feature/{ticket_id}/{type_of_change}-{short_description}

main must be always in releasable state.

Type Of Change

  • add for new features or functionality

  • change for changes in existing features or functionality

  • remove | for removed features or functionality

  • fix for any bug fixes

  • bump for dependency updates

  • security in case of vulnerabilities

Examples:

  • feature/SDK-456/add-awesome-hashing-algorithm

  • feature/add-awesome-hashing-algorithm

  • feature/remove-not-so-awesome-algorithm

  • feature/fix-algorithm-corner-case

  • feature/bump-lib-to-1.3.0

Release

A release branches of from main branch with following pattern:

  • release/{major}.{minor}(.{patch})/prepare-{major}.{minor}.{patch} while patch is optional

Add following changes:

  • Update CHANGELOG.adoc by creating a new Unreleased section and change current unreleased to release version

  • Update README.adoc project-version to release version

  • Update the latest release badge HowTo

Releases are automatically created when a tag in the form of v{major}.{minor}.{patch} is added.

Develop

TODO