Skip to content

Latest commit

 

History

History
59 lines (34 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

59 lines (34 loc) · 2.19 KB

Contributing to Riot.js

If you’d like to contribute a feature or bug fix, you can fork Riot or one of its submodules, commit your changes, & send a pull request. Please make sure to search the issue tracker first.

Development Process

master is considered safe and should be identical to the last release tag. When submitting pull requests please use the dev branch.

Coding Guidelines

Please follow the coding style established in the rest of the codebase.

Semicolons
No semicolons, please!

Spacing
Use two spaces for indentation. No tabs. Spacing around brackets: if (foo) { instead of if(foo){

Quotes
Single-quoted strings are preferred to double-quoted strings.

Equality Checking
Prefer == over === unless it's a must.

Bitwise Operations
Prefer classic conditionals i < 0 over bitwise operators !~pos

Create a test

Create a test for your specific contribution and submit it with your pull request to ensure the future stability of Riotjs

Run the tests

Before any pull request please run the following command from your terminal to be sure your changes will not break Riotjs:

$ make riot

Reporting New Issues

We use Github Issues as the Riot.js bug tracker. The best way to get your bug fixed is to provide a reduced test case. jsFiddle, jsBin, and other sites provide a way to give live examples.

Adding a new Demo

Please just add a link to the bottom of the README.md file

Updating the documentation

Please go to the website repository.

We are happy to accept PRs so thank you in advance!