Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 958 Bytes

CONTRIBUTING.md

File metadata and controls

30 lines (23 loc) · 958 Bytes

Contributing

Style

  • Always have trailing line endings on files. This is a setting you can enable in most IDEs

  • For markdown obey the style guides of a quality linter such as DavidAnson.vscode-markdownlint

  • For Source files, try to avoid nesting by using early returns under negative checks instead of branches under positive checks. Example:

    //Do not
    If (thing)
    {
      //do stuff here
    }
    
    //Do
    {
      If (!thing)
        return;
    
      //do stuff here
    }

Commits / Pull requests

  • Be descriptive of what your commits do.
  • Follow Convetional Commits to help keep track of what you are changing both for yourself and others that wish to read your code
  • Do Not commit changes to packages.lock.json
  • Avoid commiting changes to .gitignore since this will effect everyone's instance if merged. Use git rm <file> instead to ask git to stop tracking a file locally