Skip to content

Latest commit

 

History

History
112 lines (78 loc) · 2.53 KB

CONTRIBUTION_GUIDE.md

File metadata and controls

112 lines (78 loc) · 2.53 KB
Raw

Contribution Guide

Kite is developed and maintained by the SIT YiBan Workstation, hereinafter referred to as Kite Team.

Please also check:

Getting Started

Clone the repository to a local folder. Note: you have to put it in a folder named as kite.

git clone https://github.com/SIT-kite/kite-app kite
cd ./kite

Then run the necessary build steps.

flutter pub get

flutter pub run build_runner build
flutter pub run flutter_native_splash:create

Finally, build the Kite based on your platform.

# On Windows
flutter build winodws   # build for Windows
flutter build apk       # build for Android
# On macOS
flutter build macos     # build for macOS
flutter build ios       # build for iOS
flutter build apk       # build for Android
# On Linux
flutter build linux     # build for Linux
flutter build apk       # build for Android

iOS Build

Kite for iOS requires Xcode 13.4.1, the latest Xcode 13. You can download it here.

Be aware that Xcode 14 or higher doesn't work due to the compatibility issue of some dependencies.

Dependency

Flutter

Kite Team always works with the latest Flutter. As of press time, Kite Team uses:

  • Flutter 3.7.0

Code Style

Dart

As to formatting, please follow what dart format does. The dedicated configuration for Kite is line length: 120. You can run the command below to format the whole project by this principle.

dart format . -l 120

As to naming principle, please follow the official naming convention.

To be flexible and easy to reconstruct, in side of a module, relative import should be applied, meanwhile, absolute import should be applied outside.

Json

As to formatting, the indent is 2 spaces.

As to naming, please keep the key lowerCamelCase, which can be mapped to a valid dart variable name.

Kite Tool

Kite tool always works on the latest python. Requirements:

ruamel.yaml
#IF Windows
    pywin32
#ELSE
    curses
#ENDIF

The entry point is located in tool folder.

If the current working directory is the root of project.

python ./tool/main.py

Kite tool will locate the project automatically, so you can run the main.py anywhere.