https://github.com/gridonic/coding
🖥 Our coding manual.
https://github.com/gridonic/coding
coding coding-conventions coding-standards coding-style gridonic guidelines how-to
Last synced: 3 months ago
JSON representation
🖥 Our coding manual.
- Host: GitHub
- URL: https://github.com/gridonic/coding
- Owner: gridonic
- License: mit
- Created: 2014-09-01T06:55:21.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2019-10-18T14:03:51.000Z (over 5 years ago)
- Last Synced: 2025-03-24T21:51:08.195Z (3 months ago)
- Topics: coding, coding-conventions, coding-standards, coding-style, gridonic, guidelines, how-to
- Language: PHP
- Homepage: https://gridonic.ch
- Size: 74.2 KB
- Stars: 5
- Watchers: 11
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Coding manual
Our coding manual represents everything we need to know in order to keep a *consistent* coding style and make
collaboration a *breeze*.
## Table of contents
1. [Guidelines]
1. [IDEs / Editors]
1. [Linters]
1. [Recipes]
1. [Best practices]
## Guidelines
See the [`./guidelines`](./guidelines) folder for a collection of language specific coding guidelines.
## IDEs / Editors
To maintain consistent coding styles between different editors and IDEs, we use [EditorConfig].
Have a look at the [`.editorconfig`](./.editorconfig) file for any details.
## Linters
> […] generically, lint or a **linter** is any tool that flags suspicious usage in software written in any
[computer language]. […] Lint-like tools generally perform [static analysis] of source code.1
Currently we have configuration files prepared for those linters:
* [ESLint] ([`.eslintrc`](./.eslintrc))
* [stylelint] ([`.stylelintrc`](./.stylelintrc))
* [PHP_CodeSniffer] for Drupal 8 ([`phpcs.xml.dist`](guidelines/php/drupal/phpcs.xml.dist))
##
1 https://en.wikipedia.org/wiki/Lint_(software)
## Recipes
Have a look at the repository’s [Wiki] for a collection of recipes regarding specific coding challenges / topics.
## Best practices
Want to know how we write *constructors*, handle *state delegation* or use the *[factory pattern]*? Or what’s in
general the best practice to write a, b or c? Have a look at our [CodePen] account or check out the [Wiki].
##
gridonic.ch ・
gridonic.github.io ・
@gridonic
[Guidelines]: #guidelines
[Linters]: #linters
[IDEs / Editors]: #ides--editors
[Recipes]: #recipes
[Best practices]: #best-practices
[Wiki]: https://github.com/gridonic/coding/wiki
[computer language]: https://en.wikipedia.org/wiki/Computer_language
[static analysis]: https://en.wikipedia.org/wiki/Static_code_analysis
[ESLint]: http://eslint.org/
[stylelint]: https://stylelint.io/
[PHP_CodeSniffer]: https://github.com/squizlabs/PHP_CodeSniffer
[EditorConfig]: http://editorconfig.org/
[CodePen]: https://codepen.io/gridonic/collections/
[factory pattern]: https://en.wikipedia.org/wiki/Factory_method_pattern