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

Add license, move readme from org-mode to markdown

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

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2023 museum-digital
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# 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]].
## Tools used
- [[https://github.com/squizlabs/PHP_CodeSniffer][php-codesniffer]]
- [[https://github.com/phpstan/phpstan][PHPStan - PHP Static Analysis Tool]]
- [[https://phpunit.de/][phpunit]]
## 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](./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
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for the full license text.

15
README.org
View File

@ -1,15 +0,0 @@
* 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]].
** Tools used
- [[https://github.com/squizlabs/PHP_CodeSniffer][php-codesniffer]]
- [[https://github.com/phpstan/phpstan][PHPStan - PHP Static Analysis Tool]]
- [[https://phpunit.de/][phpunit]]
** 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).