Move CONTRIBUTING.md

This commit is contained in:
Nicolas Gallagher
2017-05-27 08:29:22 -07:00
parent 9163b974db
commit edef737249

109
.github/CONTRIBUTING.md vendored Normal file
View File

@@ -0,0 +1,109 @@
# Contributing
## Reporting Issues and Asking Questions
Before opening an issue, please search the [issue
tracker](https://github.com/necolas/react-native-web/issues) to make sure your
issue hasn't already been reported.
## Getting started
Visit the [Issue tracker](https://github.com/necolas/react-native-web/issues)
to find a list of open issues that need attention.
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):
```
yarn
```
## Unit tests
To run the unit tests:
```
npm test
```
…in watch mode:
```
npm run test:watch
```
## Visual tests
Run the interactive storybook:
```
npm run docs:start
```
Run generate a static build of the storybook:
```
npm run docs:build
```
Run the performance benchmarks in a browser (opening `./performance/index.html`):
```
npm run benchmarks
```
## Compile and build
Compile the source code to `dist`:
```
npm run compile
```
To create a UMD bundle of the library:
```
npm run build
```
### Pre-commit
Before creating a commit run:
```
npm run precommit
```
To format and lint the entire project:
```
npm run fmt
npm run lint
```
### New Features
Please open an issue with a proposal for a new feature or refactoring before
starting on the work. We don't want you to waste your efforts on a pull request
that we won't want to accept.
## Submitting Changes
* Open a new issue in the [Issue tracker](https://github.com/necolas/react-native-web/issues).
* Fork the repo.
* Create a new feature branch based off the `master` branch.
* Make sure all tests pass and there are no linting errors.
* Submit a pull request, referencing any issues it addresses.
Please try to keep your pull request focused in scope and avoid including
unrelated commits.
After you have submitted your pull request, we'll try to get back to you as
soon as possible. We may suggest some changes or improvements.
Thank you for contributing!