Establish quality standards (#4)

.editorconfig

@@ -8,15 +8,15 @@ root = true
 
 [*]
 charset = utf-8
+indent_style = tab
+indent_size = 4
 end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
-indent_style = tab
-indent_size = 4
 
-[{.jshintrc,*.json,*.yml}]
+[*.md]
+trim_trailing_whitespace = false
+
+[{*.json,*.yml}]
 indent_style = space
 indent_size = 2
-
-[{*.txt,wp-config-sample.php}]
-end_of_line = crlf

.github/workflows/build-test-measure.yml

@@ -0,0 +1,13 @@
+name: Build, test & measure
+
+on:
+  workflow_call:
+  pull_request:
+  push:
+    branches:
+      ['main']
+
+jobs:
+  call-workflow-build-test-measure:
+    uses: figuren-theater/code-quality/.github/workflows/build-test-measure.yml@main
+    secrets: inherit

.github/workflows/prerelease-changelog.yml

@@ -0,0 +1,12 @@
+name: 'pre-Release Changelog Update'
+
+on:
+  workflow_call:
+  release:
+    types: [prereleased]
+
+jobs:
+  call-workflow-update-changelog:
+    uses: figuren-theater/.github/.github/workflows/prerelease-changelog-update.yml@main
+    secrets: inherit
+

.github/workflows/release-drafter.yml

@@ -0,0 +1,19 @@
+name: Draft or update the next release
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - main
+  # pull_request event is required only for autolabeler
+  pull_request:
+    # Only following types are handled by the action, but one can default to all as well
+    types: [opened, reopened, synchronize]
+  # pull_request_target event is required for autolabeler to support PRs from forks
+  # pull_request_target:
+  #   types: [opened, reopened, synchronize]
+
+jobs:
+  call-workflow-release-drafter:
+    uses: figuren-theater/.github/.github/workflows/release-drafter.yml@main
+    secrets: inherit

.gitignore

@@ -1,11 +1,21 @@
-.DS_Store
-phpcs.xml
-phpunit.xml
-Thumbs.db
-wp-cli.local.yml
-node_modules/
+/build/
+/node_modules
+/vendor
 *.sql
 *.tar.gz
 *.zip
+/wiki
+.vscode
+
+# Generated via bin/transform-readme.php
+/readme.txt
+/.wp-env.override.json
+
+# misc
+.DS_Store
+Thumbs.db
 
-/vendor/
+# is created during composer install,
+# when package is tested
+# and not running within ft-platform
+/wp-content/

.phpcs.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<ruleset name="ft-options">
+	<description>Coding standards for ft-options</description>
+
+	<file>.</file>
+
+	<!--
+	<exclude-pattern>*/bin/*</exclude-pattern>
+	<exclude-pattern>*/tests/*</exclude-pattern>
+	<exclude-pattern>*/vendor/*</exclude-pattern> -->
+
+	<!--
+	is created during composer install,
+	when package is tested
+	and not running within ft-platform
+	-->
+	<exclude-pattern>*/wp-content/*</exclude-pattern>
+
+	<!-- Use figuren.theater Coding Standards -->
+	<rule ref="figurentheater" />
+
+	<!--
+	<rule ref="WordPress.WP.I18n">
+		<properties>
+			<property name="text_domain" type="array">
+				<element value="figurentheater"/>
+			</property>
+		</properties>
+	</rule> -->
+
+</ruleset>

CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased](https://github.com/figuren-theater/ft-options/compare/1.1.11...HEAD)
+
+
+

README.md

@@ -21,35 +21,25 @@
   </p>
 </div>
 
-## About 
+## About
 
 
 This is the long desc
 
 * [x] *list closed tracking-issues or `docs` files here*
 * [ ] Write better Readme
-* [ ] Do you have any [ideas](/issues/new) ?
+* [ ] Do you have any [ideas](https://github.com/figuren-theater/ft-options/issues/new) ?
 
 ## Background & Motivation
 
 ...
 
 ## Install
 
-1. Add this repository to your `composer.json`
-```json
-"repositories": [
-    {
-        "type": "git",
-        "url": "https://github.com/figuren-theater/ft-options"
-    }
-]
-```
-
-2. Install via command line
-```sh
-composer require figuren-theater/ft-options
-```
+1. Install via command line
+	```sh
+	composer require figuren-theater/ft-options
+	```
 
 ## Usage
 
@@ -61,7 +51,7 @@ Figuren_Theater::API\get_...()
 
 ### Plugins included
 
-This package contains the following plugins. 
+This package contains the following plugins.
 Thoose are completely managed by code and lack of their typical UI.
 
 * [markjaquith/wp-tlc-transients](https://packagist.org/packages/markjaquith/wp-tlc-transients)
@@ -86,6 +76,8 @@ Accompaniying the core functionality of the mentioned plugins, theese **best pra
 ## Built with & uses
 
   - [dependabot](/.github/dependabot.yml)
+  - [code-quality](https://github.com/figuren-theater/code-quality/)
+     A set of status checks to ensure high and consitent code-quality for the figuren.theater platform.
   - ....
 
 ## Contributing
@@ -105,18 +97,18 @@ Don't forget to give the project a star! Thanks again!
 ## Versioning
 
 We use [Semantic Versioning](http://semver.org/) for versioning. For the versions
-available, see the [tags on this repository](/tags).
+available, see the [tags on this repository](https://github.com/figuren-theater/ft-options/tags).
 
 ## Authors
 
   - **Carsten Bach** - *Provided idea & code* - [figuren.theater/crew](https://figuren.theater/crew/)
 
-See also the list of [contributors](/contributors)
+See also the list of [contributors](https://github.com/figuren-theater/ft-options/contributors)
 who participated in this project.
 
 ## License
 
-This project is licensed under the [GPL-3.0-or-later](LICENSE.md), see the [LICENSE](LICENSE) file for
+This project is licensed under the **GPL-3.0-or-later**, see the [LICENSE](/LICENSE) file for
 details
 
 ## Acknowledgments

composer.json

@@ -1,10 +1,14 @@
 {
     "name": "figuren-theater/ft-options",
     "description": "Options management via code for a WordPress multisite like figuren.theater",
-    "homepage": "https://websites.fuer.figuren.theater",
-    "type": "wordpress-muplugin",
-    "keywords": ["wordpress", "multisite", "options", "settings"],
     "license": "GPL-3.0-or-later",
+    "type": "wordpress-muplugin",
+    "keywords": [
+        "wordpress",
+        "multisite",
+        "options",
+        "settings"
+    ],
     "authors": [
         {
             "name": "figuren.theater",
@@ -17,18 +21,40 @@
             "role": "Developer"
         }
     ],
+    "homepage": "https://websites.fuer.figuren.theater",
     "support": {
         "email": "info@figuren.theater",
         "issues": "https://github.com/figuren-theater/ft-options/issues",
         "source": "https://github.com/figuren-theater/ft-options"
     },
+    "require": {
+        "php": ">=7.4",
+        "figuren-theater/deprecated_figuren_theater_v2": "dev-master",
+        "markjaquith/wp-tlc-transients": "^1.0"
+    },
+    "require-dev": {
+        "figuren-theater/code-quality": "*"
+    },
+    "repositories": [
+        {
+            "type": "git",
+            "url": "https://github.com/figuren-theater/deprecated__Figuren_Theater__v2"
+        }
+    ],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
     "autoload": {
         "psr-4": {
             "Figuren_Theater\\Options\\": "inc/"
         }
     },
-    "require": {
-        "php": ">=7.1",
-        "markjaquith/wp-tlc-transients": "^1.0"
+    "config": {
+        "allow-plugins": {
+            "phpstan/extension-installer": true,
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "ergebnis/composer-normalize": true,
+            "composer/installers": true,
+            "koodimonni/composer-dropin-installer": true
+        }
     }
 }