Skip to content

Latest commit

 

History

History
90 lines (60 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

90 lines (60 loc) · 2.96 KB
Raw

Contributing to MiniApp Getting Started

First, ensure you have the latest npm.

To get started with the repo:

$ git clone git@github.com:tikivn/miniapp-getting-started.git

Download the latest Tiki Mini Studio here and see your changes in Simulator.

Follow below topics to go futher:

Code Structure

Each folder is a MiniApp Project, you can edit or create new project

Branching Strategy

We follow a "typical" branching and lifecycle model:

  • feature branches gets started from main:HEAD
  • PRs get created onto main

Commit Message Format

This specification is inspired by and supersedes the AngularJS commit message format.

We have very precise rules over how our Git commit messages must be formatted. This format leads to easier to read commit history.

Each commit message consists of a header, a body, and a footer.

<header>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and must conform to the Commit Message Header format.

The body is mandatory for all commits except for those of type "docs". When the body is present it must be at least 20 characters long and must conform to the Commit Message Body format.

The footer is optional. The Commit Message Footer format describes what the footer is used for and the structure it must have.

Any line of the commit message cannot be longer than 100 characters.

Commit Message Header

<type>(<scope>): <short summary>
  ?       ?             ?
  ?       ?             ??? Summary in present tense. Not capitalized. No period at the end.
  ?       ?
  ?       ??? Commit Scope: miniapp|mini-ui
  ?
  ??? Commit Type: build|ci|docs|feat|fix|perf|refactor|test

The <type> and <summary> fields are mandatory, the (<scope>) field is optional.

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies
  • ci: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • test: Adding missing tests or correcting existing tests
Scope

The scope should be the name of the project (E.g shopping)

Publish App

You have to Login and Upload App with Tiki Studio. For more information, please follow Upload App