CONTRIBUTING.md

Contributing to homs

Submitting a pull request

To submit a pull request you should fork the homs repository, and make your change on a feature branch of your fork. Then generate a pull request from your branch against master of the homs repository. Include in your pull request details of your change -- the why and the how -- as well as the testing your performed. Also, be sure to run the test suite with your change in place. Changes that cause tests to fail cannot be merged.

There will usually be some back and forth as we finalize the change, but once that completes it may be merged.

You should update CHANGELOG.md.

If you know all supported languages – add translations in all languages. Otherwise – create issue to translate missing languages.

Code style

We are following several style guides:

• Ruby Style Guide

• Airbnb JavaScript Style Guide

  With some notes:

  • 7.11, 19.3 Add spaces before and after paren in function declaration:

    // bad
    const f = function(){};
    const g = function (){};
    const h = function() {};
    const j = function a() {};
    
    // good
    const x = function () {};
    const y = function a () {};

  • 16.3 Else-return is allowed.

• Airbnb React/JSX Style Guide