From 7d59d52bbbe453a8f04051bcaffce4f91ac09de4 Mon Sep 17 00:00:00 2001 From: Joshua Ramon Enslin Date: Sat, 24 Jun 2023 00:19:34 +0200 Subject: [PATCH] Add license, move readme from org-mode to markdown --- LICENSE | 21 +++++++++++++++++++++ README.md | 19 +++++++++++++++++++ README.org | 15 --------------- 3 files changed, 40 insertions(+), 15 deletions(-) create mode 100644 LICENSE create mode 100644 README.md delete mode 100644 README.org diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..01109d4 --- /dev/null +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..634995f --- /dev/null +++ b/README.md @@ -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. diff --git a/README.org b/README.org deleted file mode 100644 index e131daf..0000000 --- a/README.org +++ /dev/null @@ -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).