museum-digital/MD_QA
31
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix links in README

Browse Source
This commit is contained in:
Joshua Ramon Enslin 2023-06-24 00:21:15 +02:00
parent 7d59d52bbb
commit 67241c8d54
Signed by: jrenslin
GPG Key ID: 46016F84501B70AE
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,18 +1,18 @@
# Quality Assurance Settings for museum-digital # Quality Assurance Settings for museum-digital
Most of the code used at [[https://www.museum-digital.org][museum-digital]] is written in PHP. To keep a uniform code style throughout the code, we use [[https://github.com/squizlabs/PHP_CodeSniffer][PHP Code Sniffer]]. Most of the code used at [museum-digital](https://www.museum-digital.org) is written in PHP. To keep a uniform code style throughout the code, we use [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer).
## Tools used ## Tools used
- [[https://github.com/squizlabs/PHP_CodeSniffer][php-codesniffer]] - [php-codesniffer](https://github.com/squizlabs/PHP_CodeSniffer)
- [[https://github.com/phpstan/phpstan][PHPStan - PHP Static Analysis Tool]] - [PHPStan - PHP Static Analysis Tool](https://github.com/phpstan/phpstan)
- [[https://phpunit.de/][phpunit]] - [phpunit](https://phpunit.de/)
## This Repository ## This Repository
This repository serves to collect generally applicable rules, that can be embedded into the specific rule sets of the different projects. 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](./rules/md_phpcs_rules.xml)` contains the main style guide. When rewriting files to fit the uniform style rules, ``[md_phpcs_rules_basic.xml](./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). The file [`md_phpcs_rules.xml`](./rules/md_phpcs_rules.xml) contains the main style guide. When rewriting files to fit the uniform style rules, ``[md_phpcs_rules_basic.xml](./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).
## License ## License