https://github.com/bytecodeagency/coding-standards
(MIRROR) Bytecode Coding Standards. Includes guidelines for Security, Git, Docker, HTML/CSS, JS/TS, PHP, Python and Elixir.
https://github.com/bytecodeagency/coding-standards
Last synced: 10 months ago
JSON representation
(MIRROR) Bytecode Coding Standards. Includes guidelines for Security, Git, Docker, HTML/CSS, JS/TS, PHP, Python and Elixir.
- Host: GitHub
- URL: https://github.com/bytecodeagency/coding-standards
- Owner: BytecodeAgency
- License: gpl-3.0
- Created: 2018-09-18T18:39:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-20T18:11:31.000Z (almost 6 years ago)
- Last Synced: 2024-04-23T22:26:29.767Z (almost 2 years ago)
- Language: CSS
- Homepage: https://bytecode.nl
- Size: 675 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Bytecode Digital Agency B.V. Coding Standards
[](https://bytecode.nl)
[](http://perso.crans.org/besson/LICENSE.html)
[](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
[](https://app.fossa.io/projects/custom%2B4543%2Fgit%40git.bytedev.io%3Abytecode%2Fcoding-standards.git?ref=badge_shield)
[](https://www.codacy.com/app/lucianonooijen/coding-standards_2?utm_source=git.bytedev.io&utm_medium=referral&utm_content=bytecode/coding-standards&utm_campaign=Badge_Grade)
## About
The coding standards for developers at Bytecode Digital Agency B.V. to ensure code health and quality of the products delivered to our clients.
All of our conventions regarding indentation and such can also be found in the form of an `.editorconfig` file.
Please read this file thoroughly, and also check out the links in the [Final words](#final-words) section. Spending half an hour now can save you many hours during projects!
*For installing all Javascript/Typescript linting dependencies, you can use a shell script, just run `curl https://raw.githubusercontent.com/BytecodeAgency/Coding-Standards/master/bin/bootstrap | bash` while within the repo you want to bootstrap*
# Table of Contents
We will discuss the following points in this Coding Standards file:
* [General](./docs/general)
* [Testing](./docs/testing)
* [Security](./docs/security)
* [Typescript](./docs/typescript)
* [PHP](./docs/php)
* [Python](./docs/python)
* [Elixir](./docs/elixir)
* [HTML, CSS, SASS](./docs/html)
* [Git](./docs/git)
* [Docker](./docs/docker)
# Final words
Some final words of this Coding Guidelines file:
#### Recommended books about clean code
* "Clean Code" by Robert C. Martin (Uncle Bob)
* "The Clean Coder" by Robert C. Martin (Uncle Bob)
#### Sources
The following sources are used for the creation of this Coding Guidelines file, please also read the following sources (you don't have to go in depth), because of course we couldn't add every single usable detail in this file.
* [Airbnb Javascript standards](https://github.com/airbnb/javascript)
* [Javascript project guidelines](https://github.com/wearehive/project-guidelines)
* [Sitepoint SASS project architecture](https://www.sitepoint.com/architecture-sass-project/)
* [SASS Guidelin.es](https://sass-guidelin.es/), please read [this](https://sass-guidelin.es/#too-long-didnt-read) part for some great tips
* [Altavia ACT styleguide](https://github.com/Altavia-ACT/styleguide)
* [Gitignore creator](https://www.gitignore.io/)
* [WordPress Codex](https://codex.wordpress.org/)
* [Roots.io](https://roots.io/)
* [Wikipedia - DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself)
* [Fibonacci](https://3.7designs.co/blog/2010/10/how-to-design-using-the-fibonacci-sequence/)
* [Yarn](https://www.sitepoint.com/yarn-vs-npm/)
* [BEM](http://getbem.com/naming/)
#### Starter packs
* Try to not use starter packs at all
* This repo for Parcel/Handlebars development
* [Mega Boiler Plate](https://github.com/sahat/megaboilerplate)
#### Contributors
* [Luciano Nooijen - Bytecode Digital Agency B.V.](https://bytecode.nl)
* [Jeroen van Steijn - Bytecode Digital Agency B.V.](https://bytecode.nl)