graze/standards

Graze coding standards

Maintainers

Details

github.com/graze/standards

Homepage

Source

Issues

Installs: 334 146

Dependents: 49

Suggesters: 0

Security: 0

Stars: 6

Watchers: 14

Forks: 2

Open Issues: 1

v2.0.5 2020-08-18 15:43 UTC

Requires (Dev)

MIT eac7737b0ca12c31d98987c981ce39448dd789c8

  • Graze Developers <developers.woop@graze.com>

standardscodinggraze

This package is auto-updated.

Last update: 2024-10-29 04:20:00 UTC

README

This documentation is also available in mkdocs.

This document describes the coding standards of Graze across its common languages to be adhered to and enforced by the Graze tech team, any violation of standards must be justified by the developer and exceptions are allowed for cases where it is unavoidable, such as in the case of third-party integrations.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

General

  1. Indent size MUST be 4 space characters and MUST NOT be the tab character.
  2. All files MUST end with a blank new line (the new line character).
  3. All files MUST use the Unix LF (linefeed) line ending.
  4. There MUST NOT be trailing whitespace.

Git

  1. Repo names SHOULD be all lowercase with hyphens (-) to separate words where appropriate.
  2. Internal-only libraries SHOULD be prefixed with "graze-".
  3. It is RECOMMENDED to follow the style guide mantained in agis-/git-style-guide.

Languages

  1. PHP
  2. HTML
  3. Javascript
  4. Python
  5. SQL
  6. CSS/Less
  7. Markdown
  8. Golang

Open Source

  1. Project
  2. PHP

Environment

  1. AWS
  2. Docker

Visual

  1. Images

Development

You can test mkdocs by calling:

make docs-test

This will start a development server in docker on port 8000.