Skip to content

Latest commit

 

History

History
44 lines (33 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

44 lines (33 loc) · 1.55 KB

Contributing to Project Cue

Where to start?

If you're new to the Project Cue app and want to contribute, there is a list of good first bugs.

Coding standard

The code base is written in es2015, make sure to use semantic and syntactic idioms in this flavour of JavaScript.

For CSS, we're following BEM methodology.

The coding standard is not documented but most of the important features are enforced using eslint and stylelint. So it's really easy to get acquainted with the most of coding styles just by reading through .eslintrc and .stylelintrc located at the project's root. To ensure your code is compatible a pre-commit hook is run. Alternatively, you can run the linting task this way:

$ gulp lint

If there are any, fix the errors in your code until the task is successful. It can also be helpful to take a look at the warnings and see if any parts of your code can be improved.

Coding style

Unlike coding standard, the coding style is not yet enforced or documented. Please become familiar with the code base and make sure you respect the style in place.

As an example of coding style, the promises are usually split and indented this way:

api.doPromise()
  .then((result) => {
    // Process result.
  });

Testing

If your pull request fixes a bug in the code base, please write a unit or integration test to avoid regression in the future.