initialize project

mimmi20 · Feb 11, 2022 · 3e74526 · 3e74526
1 parent db69bd0
commit 3e74526
Show file tree

Hide file tree

Showing 16 changed files with 496 additions and 43 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -6,12 +6,9 @@ For details, take a look at the following workflow configuration files:
 
 - [`workflows/continuous-integration.yaml`](workflows/continuous-integration.yaml)
 - [`workflows/lock-closed-issues.yaml`](workflows/lock-closed-issues.yaml)
-- [`workflows/stale.yaml`](workflows/stale.yaml)
 
 ## Coding Standards
 
-We are using [`ergebnis/composer-normalize`](https://github.com/ergebnis/composer-normalize) to normalize `composer.json`.
-
 We are using [`friendsofphp/php-cs-fixer`](https://github.com/FriendsOfPHP/PHP-CS-Fixer) and [`squizlabs/php_codesniffer`](https://github.com/squizlabs/PHP_CodeSniffer) to enforce coding standards in PHP files.
 
 Run

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -6,7 +6,8 @@ updates:
  - package-ecosystem: "composer"
  directory: "/"
  schedule:
- interval: "daily"
+ interval: "weekly"
+ day: "monday"
  time: "04:00"
  timezone: "Europe/Berlin"
  open-pull-requests-limit: 10
@@ -16,7 +17,7 @@ updates:
  - "mimmi20"
  labels:
  - "dependencies"
- versioning-strategy: "widen"
+ versioning-strategy: "increase"
  commit-message:
  include: "scope"
  prefix: "composer"
@@ -31,7 +32,8 @@ updates:
  - package-ecosystem: "github-actions"
  directory: "/"
  schedule:
- interval: "daily"
+ interval: "weekly"
+ day: "monday"
  time: "04:00"
  timezone: "Europe/Berlin"
  open-pull-requests-limit: 10

diff --git a/.github/labels.yml b/.github/labels.yml
@@ -54,7 +54,7 @@
  name: "documentation"
  description: "Improvements or additions to documentation"
 
-# other Labels to mimmi20/template
+# other Labels to mimmi20/contact
 #- color: 5319e7
 # name: "new useragents"
 # description: ""

diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -32,7 +32,7 @@ categories:
  - title: '**🧹 Maintenance:**'
  labels:
  - 'maintenance'
- # other Labels to mimmi20/template
+ # other Labels to mimmi20/contact
  #- title: '**📦 new Useragents:**'
  # labels:
  # - 'new useragents'
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -7,7 +7,7 @@ on:
 name: "Continuous Integration"
 
 env:
- PHP_EXTENSIONS: "json, opcache, mbstring"
+ PHP_EXTENSIONS: "json, opcache"
  PHP_INI_VALUES: "opcache.enable=1, opcache.fast_shutdown=0, zend.assertions=1, assert.exception=On, intl.default_locale=de, intl.use_exceptions=1, zend.exception_ignore_args=0"
  COMPOSER_OPTIONS: "--optimize-autoloader --prefer-dist --prefer-stable -v"
  TOOLS: "composer:v2"
@@ -155,7 +155,7 @@ jobs:
  composer-options: "${{ env.COMPOSER_OPTIONS }}"
 
  - name: "Check dependencies with composer"
- run: "composer outdated --direct --strict"
+ run: "composer outdated --direct"
 
  php-cs-fixer:
  name: "Check Coding Standards with PHP-CS-Fixer"
@@ -408,13 +408,17 @@ jobs:
 
  matrix:
  operating-system:
+ - "ubuntu-18.04"
  - "ubuntu-20.04"
 
  php-version:
  - "7.4"
+ - "8.0"
+ - "8.1"
 
  dependencies:
  - "highest"
+ - "lowest"
 
  coverage-drivers:
  - "xdebug"
@@ -455,7 +459,7 @@ jobs:
  verbose: false
 
  - name: "Run mutation tests with infection/infection"
- run: "infection -s --min-covered-msi=84 --min-msi=84 --coverage=.build/coverage --logger-github"
+ run: "infection -s --min-covered-msi=93 --min-msi=90 --coverage=.build/coverage --logger-github"
 
  roave-backwards-compatibility-check:
  name: "Check for Backward Compatibility breaks"

diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the mimmi20/template package.
+ * This file is part of the mimmi20/contact package.
  *
  * Copyright (c) 2020-2021, Thomas Mueller <[email protected]>
  *
@@ -11,9 +11,9 @@
 declare(strict_types = 1);
 
 $header = <<<'EOF'
- This file is part of the mimmi20/template package.
+ This file is part of the mimmi20/contact package.
 
- Copyright (c) 2020-2021, Thomas Mueller <[email protected]>
+ Copyright (c) 2022, Thomas Mueller <[email protected]>
 
  For the full copyright and license information, please view the LICENSE
  file that was distributed with this source code.

diff --git a/README.md b/README.md
@@ -1,29 +1,27 @@
-# template
+# contact
 
-[![Latest Stable Version](https://poser.pugx.org/mimmi20/template/v/stable?format=flat-square)](https://packagist.org/packages/mimmi20/template)
-[![Latest Unstable Version](https://poser.pugx.org/mimmi20/template/v/unstable?format=flat-square)](https://packagist.org/packages/mimmi20/template)
-[![License](https://poser.pugx.org/mimmi20/template/license?format=flat-square)](https://packagist.org/packages/mimmi20/template)
+[![Latest Stable Version](https://poser.pugx.org/mimmi20/contact/v/stable?format=flat-square)](https://packagist.org/packages/mimmi20/contact)
+[![Latest Unstable Version](https://poser.pugx.org/mimmi20/contact/v/unstable?format=flat-square)](https://packagist.org/packages/mimmi20/contact)
+[![License](https://poser.pugx.org/mimmi20/contact/license?format=flat-square)](https://packagist.org/packages/mimmi20/contact)
 
 ## Code Status
 
-[![codecov](https://codecov.io/gh/mimmi20/template/branch/master/graph/badge.svg)](https://codecov.io/gh/mimmi20/template)
-[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/mimmi20/template.svg)](http://isitmaintained.com/project/mimmi20/template "Average time to resolve an issue")
-[![Percentage of issues still open](http://isitmaintained.com/badge/open/mimmi20/template.svg)](http://isitmaintained.com/project/mimmi20/template "Percentage of issues still open")
+[![codecov](https://codecov.io/gh/mimmi20/contact/branch/master/graph/badge.svg)](https://codecov.io/gh/mimmi20/contact)
+[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/mimmi20/contact.svg)](http://isitmaintained.com/project/mimmi20/contact "Average time to resolve an issue")
+[![Percentage of issues still open](http://isitmaintained.com/badge/open/mimmi20/contact.svg)](http://isitmaintained.com/project/mimmi20/contact "Percentage of issues still open")
 
-## Installation
+## Requirements
+
+This library requires PHP 7.4+.
 
-:bulb: This is a great place for showing how to install the package, see below:
+## Installation
 
 Run
 
 ```
-$ composer require mimmi20/template
+$ composer require mimmi20/contact
 ```
 
-## Usage
-
-:bulb: This is a great place for showing a few usage examples!
-
 ## License
 
 This package is licensed using the MIT License.

diff --git a/composer.json b/composer.json
@@ -1,31 +1,46 @@
 {
- "name": "mimmi20/template",
- "description": "Provides a GitHub repository template for a PHP library, using GitHub actions.",
+ "name": "mimmi20/contact",
+ "description": "A small contact class to use in other projects",
  "license": "MIT",
  "type": "library",
  "authors": [
  {
  "name": "Thomas Müller",
  "homepage": "https://github.com/mimmi20",
  "role": "Developer"
+ },
+ {
+ "name": "Contributors",
+ "homepage": "https://github.com/mimmi20/contact/graphs/contributors"
  }
  ],
- "homepage": "https://github.com/mimmi20/template",
+ "homepage": "https://github.com/mimmi20/contact",
  "support": {
- "issues": "https://github.com/mimmi20/template/issues",
- "source": "https://github.com/mimmi20/template"
+ "issues": "https://github.com/mimmi20/contact/issues",
+ "source": "https://github.com/mimmi20/contact"
  },
  "require": {
- "php": "^7.4.3 || ^8.0.0",
- "ext-mbstring": "*"
+ "php": "^7.4.3 || ^8.0.0"
  },
  "require-dev": {
- "mimmi20/coding-standard": "^2.6.2",
+ "mimmi20/coding-standard": "^2.6.3",
  "phpstan/extension-installer": "^1.1.0",
- "phpstan/phpstan": "^1.4.2",
+ "phpstan/phpstan": "^1.4.6",
  "phpstan/phpstan-deprecation-rules": "^1.0.0",
  "phpstan/phpstan-phpunit": "^1.0.0",
- "phpunit/phpunit": "^9.5.12"
+ "phpunit/phpunit": "^9.5.13"
+ },
+ "minimum-stability": "dev",
+ "prefer-stable": true,
+ "autoload": {
+ "psr-4": {
+ "Mimmi20\\Contact\\": "src/"
+ }
+ },
+ "autoload-dev": {
+ "psr-4": {
+ "Mimmi20\\Contact\\": "tests/"
+ }
  },
  "config": {
  "preferred-install": "dist",

diff --git a/phpcs.xml b/phpcs.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0"?>
-<ruleset name="browser-detector"
+<ruleset name="contact"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"
 >
- <description>browser-detector</description>
+ <description>contact</description>
 
  <arg name="report" value="full"/>
  <arg value="wps"/>

diff --git a/phpmd.ruleset.xml b/phpmd.ruleset.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0"?>
-<ruleset name="mimmi20-cs"
+<ruleset name="contact"
  xmlns="http://pmd.sf.net/ruleset/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
  xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
- <description>The coding standard.</description>
+ <description>contact</description>
 
  <rule ref="rulesets/cleancode.xml">
  <exclude name="BooleanArgumentFlag"/>

diff --git a/phpunit.xml b/phpunit.xml
@@ -33,7 +33,7 @@
  <ini name="intl.use_exceptions" value="1"/>
  </php>
 
- <testsuite name="Template Test Suite">
+ <testsuite name="Contact Test Suite">
  <directory>tests/</directory>
  </testsuite>
 

diff --git a/src/.gitkeep b/src/.gitkeep