UNPKG

rnpm

Version:

React Native Package Manager

49 lines (38 loc) 1.99 kB
# Contributing guideline Dear contributor, first of all we're glad to see you on this page. Your contribution is very important for us. This project has been designed to be a community-driven application, so every time you're making an issue or opening a pull request you make this project better. We appreciate any kind of contribution, big or small - it doesn't matter. But make sure, that before you submit something, you've read our [Code of Conduct](https://github.com/rnpm/rnpm/blob/master/CODE_OF_CONDUCT.md). # Getting started In the case you want to submit a pull request, we recommend you to follow this instruction: 1. [Fork a repo](https://github.com/rnpm/rnpm#fork-destination-box) 2. Clone your fork ```bash $ git clone https://github.com/<username>/rnpm.git ``` 3. Go to the clonned folder ```bash $ cd rnpm ``` 4. Install development dependencies ```bash $ npm i ``` 5. Link rnpm so it's available globally ```bash $ npm link ``` 6. Checkout to the new branch ```bash $ git checkout -b <branch_name> ``` 7. Make an awesome changes! Don't forget to change a `<username>` to your real github username and a `<branch_name>` to something meaningful. We recommend using following convention for new branches: `<type>/<caption>`, like - `feature/add-ignore-flag` for a new feature; - `chore/improve-documentation` for a technical chore - `bug/missing-dependencies` for bugfix. We'll review / answer your issues faster, if you will provide some examples, screenshots and all the information we may need. # Questions We'd like to keep issues for bug reports and feature proposals only. If you have any questions regarding `rnpm` work, please, don't hesistate to contact us directly: - reactiflux#rnpm on Discord - [Gitter](https://gitter.im/rnpm?utm_source=share-link&utm_medium=link&utm_campaign=share-link) - [Kureev's twitter](https://twitter.com/kureevalexey) - [Grabbou's twitter](https://twitter.com/grabbou) With :heart: form @kureev and @grabbou