0
0
Fork 0
file-hider/.github/contributing.md
2022-06-09 20:35:47 -06:00

1.4 KiB

Contributing Guidelines

General Overview

Code can be edited and changed on the main branch, any large features or

Code Style

  • Indents should be done with tabs, one tab character per level of indentation.
  • Functions should only be asynchronous if they need to be.
  • Function names should be camelCase
  • Variable names should be camelCase
  • Constant names should be SCREAMING_SNAKE_CASE, except when used in a for ... of loop.
  • Class names should be CapitalCamelCase
  • Brackets should always be included, even if not needed.
    Good:
    if ( /* conditional */ ) {
      /* ... snip ... */
    };
    
    Bad:
    if ( /* conditional */ )
      /* ... snip ... */
    
  • Semicolons should always be included, even if not needed.
    Good:
    if ( /* conditional */ ) {
      console.log(`A statement`);
    };
    
    Bad:
    if ( /* conditional */ ) {
      console.log(`A statement`)
    }
    

Extras

If there's anything you think was missed please open a new discussion on GitHub so it can be discussed.