CONTRIBUTING.md

Thank you for considering to contribute to "bridge."

Starting development

Open the terminal, cd to the directory you have cloned "bridge." to and run npm i. Afterwards, you can use npm run dev and npm run build to start the development environment and build versions of "bridge.".

Code Rules

Verified as working

All code contributed to this repository should be verified as working, meaning you've tested the functionality at least once and didn't encounter unexpected behaviour. Your build also may not contain errors inside the console.

Code Style

General

Although not required by the language JavaScript itself, you should end all instructions with a ";".

Names

Variable, constant and parameter names should all be snake_case. This also includes Vue's computed properties.

// Example
let my_var = "Hello World!";

Method and function names are prefered to be CamelCase.

// Example
function doSomethingNow(par_1, par_2) {
  doSomething(par_1 + par_2);
}

Method Chaining

Wherever it makes sense, you should chain methods by inserting a new line to improve readability first.

// Example
doSomething()
  .then(data => data.string())
  .then(str => console.log(str))
  .catch(err => console.error(err))
  .finally(updateUI());