2017 © Pedro Peláez
 

library standards

Graze coding standards

image

graze/standards

Graze coding standards

  • Thursday, July 12, 2018
  • by graze
  • Repository
  • 13 Watchers
  • 5 Stars
  • 96,073 Installations
  • PHP
  • 29 Dependents
  • 0 Suggesters
  • 0 Forks
  • 2 Open issues
  • 18 Versions
  • 13 % Grown

The README.md

Graze Coding Standards

This documentation is also available in mkdocs., (*1)

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., (*2)

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., (*3)

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:, (*4)

make docs-test, (*5)

This will start a development server in docker on port 8000., (*6)

The Versions

12/07 2018

dev-master

9999999-dev https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

The Development Requires

by Graze Developers
by Will Pillar

standards coding graze

12/07 2018

dev-docker-updates

dev-docker-updates https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

The Development Requires

by Graze Developers

standards coding graze

02/02 2018

dev-mkdocs-code-highlighting

dev-mkdocs-code-highlighting https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

The Development Requires

by Graze Developers

standards coding graze

02/02 2018

dev-mkdocs

dev-mkdocs https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

The Development Requires

by Graze Developers

standards coding graze

02/02 2018

dev-new-php-versions

dev-new-php-versions https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

The Development Requires

by Graze Developers

standards coding graze

06/11 2017

v2.0.1

2.0.1.0 https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

The Development Requires

by Graze Developers

standards coding graze

06/11 2017

dev-fixCsReturn

dev-fixCsReturn https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

The Development Requires

by Graze Developers

standards coding graze

25/09 2017

dev-docker

dev-docker https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

The Development Requires

by Graze Developers

standards coding graze

23/08 2017

dev-markdown-lint

dev-markdown-lint https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

The Development Requires

by Graze Developers

standards coding graze

23/08 2017

v2.0.0

2.0.0.0 https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

The Development Requires

by Graze Developers

standards coding graze

20/03 2017

dev-open-source

dev-open-source https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

by Will Pillar

standards coding graze

09/03 2017

dev-open-source-standards

dev-open-source-standards https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

by Will Pillar

standards coding graze

13/12 2016

dev-log-format

dev-log-format https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

by Will Pillar

standards coding graze

05/12 2016

dev-space-after-cast

dev-space-after-cast https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

by Will Pillar

standards coding graze

02/12 2016

dev-feature/PLA-370-AWS-Naming-Conventions

dev-feature/PLA-370-AWS-Naming-Conventions https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

by Will Pillar

standards coding graze

19/10 2016

dev-phpcs-3

dev-phpcs-3 https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

The Development Requires

by Will Pillar

standards coding graze

20/07 2016

dev-return-void

dev-return-void https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

by Will Pillar

standards coding graze

16/02 2016

v1.0.0

1.0.0.0 https://github.com/graze/standards

Graze coding standards

  Sources   Download

MIT

by Will Pillar

standards coding graze