riot

Simple and elegant component-based UI library

Important

This branch hosts the work for riot4 it's not stable and it's not meant to be used only by the riot core contributors

How to contribute

If you are reading this it's already a good sign and we are thankful for it! We try our best working as much as we could on riot but your help is always appreciated.

If you want to contribute to riot helping us maintaining the project please check first the list of our open issues to understand whether there is a task where you could help.

Riot is mainly developed on UNIX systems so you will be able to run all the commands necessary to build and test the library using our Makefile. If you are on a Microsoft machine it could be harder to set up you development environment properly.

Following the steps below you should be able to properly submit your patch to the project

1) Clone the repo and browse to the riot folder

$ git clone [e-mail]:riot/riot.git && cd riot

2) Set up your git branch

$ git checkout -b feature/my-awesome-patch

3) Install the npm dependencies

$ npm i

4) Build and test riot using the Makefile

# To build and test riot
$ make riot

# To build without testing
$ make raw

# To build anytime you change a src file
$ make watch

# To bench riot ( it requires ctrl+c to exit )
$ make perf

5) Pull request only against the dev branch making sure you have read our pull request template

6) Be patient

Credits

Riot is made with :heart: by many smart people from all over the world. Thanks to all the contributors
It's actively maintained by:

Richard Bondi

Gianluca Guarini

Tsutomu Kawamura

Alberto Martínez

Grant Marvin

Tero Piirainen

Official Website

http://riotjs.com/

Backers

Support us with a monthly donation and help us continue our activities. Become a backer

Sponsors

Become a sponsor to get your logo on our README. Become a sponsor