Skip to content

Latest commit

 

History

History
112 lines (73 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

112 lines (73 loc) · 3.07 KB
Raw

Contributing Guide

Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.

Setting up your environment

After forking to your own github org, do the following steps to get started:

# clone your fork to your local machine
git clone https://github.com/airbnb/lottie-react-native.git

# step into local repo
cd lottie-react-native

# install dependencies
npm install

# run packager for development
npm run run:packager

Developing on Android

While the packager is running and you have an Android device or emulator connected to your computer, build and launch the Android app.

npm run run:android

Developing on iOS

You need to download the iOS dependencies at least once before you run the app.

npm run build:pods

While the packager is running and you have an iOS device or simulator connected to your computer, build and launch the iOS app.

npm run run:ios

Developing on Web

First, you have to install all dependencies:

yarn

After that, you have to build the library. You have to do that each time you want to see the changes in the example app, as currently, we don't support hot reloading in the demo app.

yarn setup

Finally, you can run the demo. Then you can go to the link printed in the terminal to see the demo.

yarn paper:web

Style & Linting

This codebase adheres to the Airbnb Styleguide and is enforced using ESLint.

It is recommended that you install an eslint plugin for your editor of choice when working on this codebase, however you can always check to see if the source code is compliant by running:

npm run lint

For linting the native iOS package, we are using Swift lint. You need to install it on your machine using the following command:

brew install swiftlint

And then you can run it by calling it from JS using:

yarn lint:swift

Or let it work on its own, as it is part of the build phases for the iOS project

Building Docs

Building the docs locally is extremely simple. First execute the following command:

npm run docs:watch

After this, you can open up your browser to the specified port (usually http://localhost:4000 )

The browser will automatically refresh when there are changes to any of the source files.

Pull Request Guidelines

Before you submit a pull request from your forked repo, check that it meets these guidelines:

  1. If the pull request adds functionality, the docs should be updated as part of the same PR.
  2. If the pull request adds functionality, code in the example app that demonstrates the new functionality should be updated as part of the same PR.
  3. If the pull request adds functionality, the PR description should include motivation and use cases for the feature.
  4. If the pull request fixes a bug, an explanation including what the bug was, and how to reproduce it should be included in the PR description.
  5. Please rebase and resolve all conflicts before submitting.