Skip to content

Latest commit

 

History

History
35 lines (20 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

35 lines (20 loc) · 1.68 KB

Contribution Guide

We welcome contributions from anyone on the internet and are grateful for even the smallest contributions. This document will help get you setup to start contributing.

Getting started

  1. Fork noelyoo/react-native-timer-countdown
  2. Clone your fork
  3. Follow the installation & build steps in the README.
  4. Setup the recommended Development Tooling.
  5. Open a PR against the development branch and describe the change you are intending to undertake in the PR description. (see our branch naming conventions)

Branch structure

We have two main branches:

  • master represents the most recently released version of the codebase.
  • development represents the current development state of the codebase.

ALL PRs should be opened against development.

Development Tooling

We strongly recommend you use the VSCode text editor since most of our code is written in Typescript and it offers amazing support for the language.

Linter

We use TSLint with custom configs to keep our code-style consistent.

Auto-formatter

We use Prettier to auto-format our code. Be sure to either add a text editor integration or a pre-commit hook to properly format your code changes.