Skip to content

Latest commit

 

History

History
92 lines (70 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

92 lines (70 loc) · 3.32 KB
Raw

Weex Contributing Guide

Welcome to create Pull Requests or open Issues for bugfix, doc, example, suggestion and anything.

Branch Management

master
 ↑
dev         <--- PR(hotfix/typo)
 ↑ PR
daily       <--- CI
 ↑ merge/PR
{domain}    <--- PR(feature/bugfix)
 ↑ merge/PR
{domain}-feature-{date}

Weex Branches

  1. dev, master branch 0. dev is the stable developing branch，master is the latest (pre-)release branch. 0. Github Release is used to publish a (pre-)release version to master branch. 0. A hotfix or typo PR can be committed to dev.
  2. daily branch 0. domain branches are merged to daily every day. 0. Weex CI is built to guarantee the stability of daily.
  3. {domain} branch 0. {domain} is the stable developing branch for the specific domain including android, ios, jsfm and html5. 0. It's RECOMMENDED to commit feature or bugfix PR to domain.
  4. {domain}-feature-{date} branch 0. The branch for a developing iteration, e.g. android-feature-20160607 is an android developing iteration which is done at 2016.06.07. 0. DO NOT commit any PR to such a branch.

Branch Name

{module}-{action}-{shortName}
  • {module}, see commit log module
  • {action}
    • feature: checkout from {module} and merge to {module} later. If {module} not exists, merge to dev
    • bugfix: like feature, for bugfix only
    • hotfix: checkout from master or release tag, merge to master and {module} later. If {module} not exists, merge to dev

for example:

  • android-bugfix-memory
  • jsfm-feature-communication
  • android-hotfix-compute-layout

Commit Log

{action} [{module}] {description}
  • {action}
    • + add
    • * update or bugfix
    • - remove
  • {module}
    • Including: android, ios, jsfm, html5, component, doc, website, example, test, all
  • {description}
    • It's RECOMMENDED to close issue with syntax close #123 or fix #123, see the doc for more detail. It's useful for responding issues and release flow.

for example:

  • + [android] close #123, add refreshing for WebView
  • * [doc] fix #123, update video auto-play property
  • - [example] remove abc

Pull Request

Create Pull Requests.

Code Style Guide

Objective-C

  • Tabs for indentation(not spaces)
  • * operator goes with the variable name (e.g. Type *variable;)
  • Function definitions: place each brace on its own line.
  • Other braces: place the open brace on the line preceding the code block; place the close brace on its own line.
  • Use #pragma marks to categorize methods into functional groupings and protocol implementations
  • Follow other guidelines on GitHub Objective-C Style Guide

Java & Android