Improve project introduction and guides

Adopt the structure of the React README and improve the contribution
guidelines to include Facebook's CoC. Fix various links following the
move to a monorepo.
This commit is contained in:
Nicolas Gallagher
2017-12-26 09:01:00 +00:00
parent f52a851972
commit 1776891736
8 changed files with 297 additions and 402 deletions

View File

@@ -17,7 +17,7 @@ Fork, then clone the repo:
git clone https://github.com/your-username/react-native-web.git
```
Install dependencies (requires [yarn](https://yarnpkg.com/en/docs/install):
Install dependencies (requires [yarn](https://yarnpkg.com/en/docs/install)):
```
yarn
@@ -113,13 +113,13 @@ that we won't want to accept.
## Pull requests
**Before submitting a pull request,** please make sure the following is done:
**Before submitting a pull request**, please make sure the following is done:
1. Fork the repository and create your branch from `master`.
2. If you've added code that should be tested, add tests!
3. If you've changed APIs, update the documentation.
4. Ensure the tests pass (`yarn test`).
5. Lint and format your code (`yarn fmt && yarn lint`).
4. Lint and format your code (`yarn precommit`).
5. Ensure the tests pass (`yarn test`).
You can now submit a pull request, referencing any issues it addresses.