Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

54 lines (41 loc) · 2 KB
Raw

Contributing to React Video

So you're interested in giving us a hand? That's awesome! We've put together some brief guidelines that should help you get started quickly and easily.

Please, if you see anything wrong you can fix/improve it 👻

Installing the project

  1. Fork this project on github
  2. Clone this project on your local
  3. Then, you need to install node and npm to run the mainly packages.
  4. After installed node and npm, run this script:
$ npm install

That's it! You're done.

How to work

We are using a bunch of things to put all togethe and make the work easy.

Dependency Description
NPM Node package manager
Gulp Run some tasks (bundle, server, etc)
BrowserSync Create a localhost server with livereload
Webpack Generated a UMD bundled version
Jest Run the tests

So, have some scripts that you need to know to run the project locally. It's just fews, but it's very important.

Command Description
npm run bundle run $ gulp bundle task
npm start Run $ gulp default task
npm test Run all tests with Jest
gulp Default task that runs gulp webpack, gulp server and gulp watch
gulp webpack Run the Webpack bundle
gulp webpack -p Run the Webpack bundle minified
gulp css Compile .styl files
gulp css -p Compile .styl files in a minified version
gulp server Run the BrowserSync server
gulp bundle Make the entire bundle with Gulp (compressed and uncompreed version)
gulp watch Watch when the lib files change

Submitting a Pull request

  1. Create your feature branch: git checkout -b my-new-feature
  2. Commit your changes: git commit -m 'Add some feature'
  3. Push to the branch: git push origin my-new-feature
  4. Make sure that all bundles are passing in TravisCI
  5. Submit a pull request :D