Skip to content
This repository has been archived by the owner on Oct 23, 2021. It is now read-only.

Latest commit

 

History

History
64 lines (41 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

64 lines (41 loc) · 1.6 KB

This started out as a personal project when I had a lot of time on my hands a while ago. There is still enough room for improvement and I do plan on eventually expanding this and tackling most issues, however since I made this my available free time has been rather limited so I very much do welcome contributions.

The structure of the project itself is rather simple and I tried to comment as much as possible. Other than that I ask that you follow the below programming style guide.

Style Notes:

  • Use spaces not tabs. Tabs will get you killed.

Use single quotes for all javascript stuff and double quotes for html in variables.

Example:

     const variable = '<div class="tb-class">content</div>' 

Use template literals for multi-line strings and strings containing variables/expressions

MDN page Examples:

     const multiLine = `string text line 1
                         string text line 2`;

     const expression =`string text ${expression} string text`

Use 'let' or 'const' for variable declarations

Statements longer than one line need to be bracketed.

Allowed:

    if (notEnabled) return;

Not allowed:

    if (notEnabled)
        return;

Bear food:

    if (notEnabled)
        return;
    else
        run();

If you make it two lines without brackets you will be fed to the bear.

    if (notEnabled) return;
    else run();