Quality assurance settings at museum-digital
Go to file
2023-06-23 23:06:27 +02:00
rules Allow nullable parameters and return values 2023-06-23 23:06:27 +02:00
README.org Fix org-mode markup for links in Readme 2020-10-10 21:31:04 +02:00

Quality Assurance Settings for museum-digital

Most of the code used at museum-digital is written in PHP. To keep a uniform code style throughout the code, we use PHP Code Sniffer.

This Repository

This repository serves to collect generally applicable rules, that can be embedded into the specific rule sets of the different projects.

The file md_phpcs_rules.xml contains the main style guide. When rewriting files to fit the uniform style rules, md_phpcs_rules_basic.xml comes in handy as a first step. It contains the same rules, excluding some which require or encourage a more in-depth look at the code (the prohibition of procedural-style calls to mysqli functions is e.g. a good opportunity to check the efficiency of queries).