Contributing.md

How to contribute to gin-ui

Javascript Style and Code check Toolchain

Make sure you have eslint, eslint-plugin-vue and eslint-config-vue installed.

Only issue a pull request, if eslint . src/js/*.vue src/js/comp/*.vue src/js/comp/**/*.vue run at the root of the project does not return any errors.

Javascript Style Guide

Variables and Parameters

Local variables and function parameters should use snake_case and should start with a letter. By default variables should be declared with const unless let (or sometimes var) is more appropriate.

function f(first_name) {
    const some_greeting = `Hello ${first_name}`
    console.log(some_greeting)
}

Object Properties

Object properties should use also snake_case and should start with a letter.

const foo = {
    first_foo: "foo",
    then_bar: "bar"
}

Functions and Methods

Functions and methods should start with a lower case letter and should use camelCase for their names.

function countToTen() {
  return 10
}

Classes

Classes should start with an upper case letter and should also use CamelCase for their names.

class BigDog {
    doBark() {
        return "Woof"
    }
}

Miscellaneous

• Statements are not terminated with a semicolon
• Put the opening bracket at the end of the first line
• Use one space before the opening bracket
• Prefer === and !== over == and !=
• Prefer for of loops over for in
• Use colon plus one space between each property and its value
• Use double quotes around string values