1 | # Contributing Guide
|
2 |
|
3 | Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will
|
4 | always be given.
|
5 |
|
6 |
|
7 | ## Setting up your environment
|
8 |
|
9 | After forking to your own github org, do the following steps to get started:
|
10 |
|
11 | ```bash
|
12 | # clone your fork to your local machine
|
13 | git clone https://github.com/airbnb/lottie-react-native.git
|
14 |
|
15 | # step into local repo
|
16 | cd lottie-react-native
|
17 |
|
18 | # install dependencies
|
19 | npm install
|
20 |
|
21 | # run packager for development
|
22 | npm run run:packager
|
23 | ```
|
24 |
|
25 | ### Developing on Android
|
26 |
|
27 | ### Developing on iOS
|
28 |
|
29 | ### Style & Linting
|
30 |
|
31 | This codebase adheres to the [Airbnb Styleguide](https://github.com/airbnb/javascript) and is
|
32 | enforced using [ESLint](http://eslint.org/).
|
33 |
|
34 | It is recommended that you install an eslint plugin for your editor of choice when working on this
|
35 | codebase, however you can always check to see if the source code is compliant by running:
|
36 |
|
37 | ```bash
|
38 | npm run lint
|
39 | ```
|
40 |
|
41 |
|
42 | ### Building Docs
|
43 |
|
44 | Building the docs locally is extremely simple. First execute the following command:
|
45 |
|
46 | ```bash
|
47 | npm run docs:watch
|
48 | ```
|
49 |
|
50 | After this, you can open up your browser to the specified port (usually http://localhost:4000 )
|
51 |
|
52 | The browser will automatically refresh when there are changes to any of the source files.
|
53 |
|
54 |
|
55 | ## Pull Request Guidelines
|
56 |
|
57 | Before you submit a pull request from your forked repo, check that it meets these guidelines:
|
58 |
|
59 | 1. If the pull request adds functionality, the docs should be updated as part of the same PR.
|
60 | 1. 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.
|
61 | 1. If the pull request adds functionality, the PR description should include motivation and use cases for the feature.
|
62 | 1. 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.
|
63 | 1. Please rebase and resolve all conflicts before submitting.
|