docs: Add CONTRIBUTING.md (#9)

* docs: Add CONTRIBUTING.md * Update CONTRIBUTING.md Co-Authored-By: Michał Pierzchała <[email protected]> * Reformat CONTRIBUTING.md
react-native-art · Jun 18, 2019 · ecb777b · ecb777b
1 parent ce28453
commit ecb777b
Showing 1 changed file with 50 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,50 @@
+# Contributing to React Native ART
+
+## Development Process
+
+All work on React Native ART happens directly on GitHub. Contributors send pull requests which go through review process.
+
+> **Working on your first pull request?** You can learn how from this _free_ series: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
+
+1. Fork the repo and create your branch from `master` (a guide on [how to fork a repository](https://help.github.com/articles/fork-a-repo/)).
+2. Run `yarn` or `npm install` to install all required dependencies.
+3. Now you are ready to do the changes.
+
+## Testing your changes
+
+You can test your changes by installing `example` app on a simulator or device:
+
+Installing on a iOS:
+
+- Open `example/ios/example.xcodeproj`
+- Click `run` in the top left corner of `Xcode`.
+
+Installing on Android:
+
+- Connect Android Device or open Android Emulator
+- Run `yarn android`
+
+## Typechecking, linting and testing
+
+Currently we use flow for typechecking, eslint with prettier for linting and formatting the code and jest for testing.
+
+- `yarn flow`: run flow
+- `yarn lint`: run eslint and prettier
+- `yarn test`: run unit tests
+
+## Sending Pull Request
+
+When you're sending a pull request:
+
+- Prefer small pull requests focused on one change.
+- Verify that flow, eslint and all tests are passing.
+- Preview the documentation to make sure it looks good.
+- Follow the pull request template when opening a pull request.
+
+## Reporting issues
+
+You can report issues on our [bug tracker](https://github.com/react-native-community/art/issues). Please follow the issue template when opening an issue.
+
+## License
+
+By contributing to React Native ART, you agree that your contributions will be licensed under its **MIT** license.