Skip to content

Latest commit

 

History

History
110 lines (84 loc) · 2.82 KB

DEVELOPMENT.md

File metadata and controls

110 lines (84 loc) · 2.82 KB
Raw

Development

This document describes the process for running this application on your local computer.

Getting started

Android

# Clone the repository
git clone https://github.com/chrisleekr/react-native-boilerplate

# Install dependencies
npm install

# Start Metro
npm start

# Run Android
npm run android

iOS

# Clone the repository
git clone https://github.com/chrisleekr/react-native-boilerplate

# Install dependencies
npm install

# Start Metro
npm start

# Pod install
cd pod; pod install; cd ..

# Run iOS
npm run ios

Branch naming conventions

The project enforces the branch name.

  <type>/<branch name>
     │      │
     |      └─> Summary in present tense. Not capitalized. No period at the end.
     |
     └─> Type: chore, docs, feat, fix, refactor, style, or test.

Example

  feat/new-feature
  fix/the-bug
  docs/readme
  style/update-button
  refactor/change-variable
  test/add-test
  chore/some-small-thing
  perf/improve-performance
  build/update-build-step
  ci/update-ci
  revert/revert-commit
  localize/add-korean-translation
  bump/bump-version
type description
build Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
chore Updating grunt tasks etc; no production code change, Other changes that don't modify src or test files
docs Changes to the documentation
feat New feature for the user, not a new feature for build script
fix Bug fix for the user, not a fix to a build script
perf A code change that improves performance
refactor Refactoring production code, eg. renaming a variable, A code change that neither fixes a bug nor adds a feature
revert Reverts a previous commit
style Formatting, missing semi colons, etc. (white-space, formatting, missing semi-colons, changes that do not affect the meaning of the code, etc); no production code change
test Adding missing tests, refactoring tests; no production code change

Commit message conventions

The project enforces commit message conventions. To know what patterns to use, please visit commitlint and conventional commits

  type(scope?): description  #scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")

  [optional body]

  [optional footer(s)]

Allowed types are:

  • build
  • ci
  • chore
  • docs
  • feat
  • fix
  • perf
  • refactor
  • revert
  • style
  • test