Merge pull request #31 from Spomky-Labs/Preparation2.0

Preparation 2.1

.github/FUNDING.yml

@@ -1 +1,2 @@
+github: Spomky
 patreon: FlorentMorselli

.github/ISSUE_TEMPLATE/1_Bug_report.md

@@ -0,0 +1,21 @@
+---
+name: 🐛 Bug Report
+about: ⚠️ See below for security reports
+labels: Bug
+
+---
+
+**Version(s) affected**: x.y.z
+
+**Description**
+<!-- A clear and concise description of the problem. -->
+
+**How to reproduce**
+<!-- Code and/or config needed to reproduce the problem. If it's a complex bug,
+     create a "bug reproducer" as explained in: -->
+
+**Possible Solution**
+<!--- Optional: only if you have suggestions on a fix/reason for the bug -->
+
+**Additional context**
+<!-- Optional: any other context about the problem: log messages, screenshots, etc. -->

.github/ISSUE_TEMPLATE/2_Feature_request.md

@@ -0,0 +1,12 @@
+h---
+name: 🚀 Feature Request
+about: Ideas for new features and improvements
+
+---
+
+**Description**
+<!-- A clear and concise description of the new feature. -->
+
+**Example**
+<!-- A simple example of the new feature in action (include PHP code, YAML config, etc.)
+     If the new feature changes an existing feature, include a simple before/after comparison. -->

.github/ISSUE_TEMPLATE/3_Support_question.md

@@ -0,0 +1,11 @@
+---
+name: ⛔ Support Question
+about: We usually do not provide support. Please ask your question on https://stackoverflow.com/
+
+---
+
+We use GitHub issues only to discuss about bugs and new features.
+For this kind of questions about using the library or the bundle, please use
+https://stackoverflow.com/ using the tags `[cbor]` and `[php]`
+
+Thanks!

.github/ISSUE_TEMPLATE/4_Documentation_issue.md

@@ -0,0 +1,10 @@
+---
+name: ⛔ Documentation Issue
+about: See https://github.com/Spomky-Labs/cbor-php/issues for documentation issues
+
+---
+
+The documentation has its own dedicated repository. Please open your
+documentation-related issue at https://github.com/Spomky-Labs/cbor-php/issues
+
+Thanks!

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,17 +1,19 @@
 | Q             | A
 | ------------- | ---
-| Bug fix?      | yes/no <!-- #-prefixed issue number(s), if any -->
-| New feature?  | yes/no
-| BC breaks?    | yes/no
-| Deprecations? | yes/no
-| Tests added   |  <!--highly recommended for new features-->
-| Doc PR        |  <!--highly recommended for new features-->
-
+| Branch?       | <!-- see below -->
+| Bug fix?      | yes/no
+| New feature?  | yes/no <!-- please update src/**/CHANGELOG.md files -->
+| Deprecations? | yes/no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files -->
+| Tickets       | Fix #... <!-- prefix each issue number with "Fix #", no need to create an issue if none exist, explain below instead -->
+| License       | MIT
 <!--
-Fill in this template according to the PR you're about to submit.
-Replace this comment by a description of what your PR is solving.
+Replace this notice by a short README for your feature/bugfix. This will help people
+understand your PR and can be used as a start for the documentation.
 
-Please consider the following requirement:
-* Modification of existing tests should be avoided unless deemed necessary.
-* You MUST never open a PR related to a security issue. Contact Spomky in private at https://gitter.im/Spomky/
--->
+Additionally:
+ - Always add tests and ensure they pass.
+ - Never break backward compatibility (unless you are working on the next major release branch).
+ - Bug fixes must be submitted against the lowest maintained branch where they apply
+   (lowest branches are regularly merged to upper ones so they get the fixes too.)
+ - Features and deprecations must be submitted against the last major branch (e.g. 1.x).
+-->

.github/stale.yml

@@ -0,0 +1,8 @@
+daysUntilStale: 60
+daysUntilClose: 7
+staleLabel: wontfix
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+closeComment: false

.github/workflows/coding-standards.yml

@@ -0,0 +1,32 @@
+name: Coding Standards
+
+on: [push]
+
+jobs:
+  tests:
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: [ubuntu-latest]
+        php-versions: ['7.4']
+    name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Setup PHP, with composer and extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: json, mbstring, openssl
+          coverage: xdebug
+
+      - name: Install Composer dependencies
+        run: |
+          composer update --no-progress --no-suggest --prefer-dist --optimize-autoloader
+
+      - name: ECS
+        run: make coding-standards

.github/workflows/mutation-tests.yml

@@ -0,0 +1,35 @@
+name: Mutation Testing
+
+on: [push]
+
+jobs:
+  tests:
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: [ubuntu-latest]
+        php-versions: ['7.4']
+    name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Setup PHP, with composer and extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: json, mbstring, openssl
+          coverage: xdebug
+
+      - name: Install Composer dependencies
+        run: |
+          composer update --no-progress --no-suggest --prefer-dist --optimize-autoloader
+
+      - name: Fetch Git base reference
+        run: git fetch --depth=1 origin $GITHUB_BASE_REF
+
+      - name: Infection
+        run: make mutation-tests-github

.github/workflows/rector_checkstyle.yaml

@@ -0,0 +1,29 @@
+name: Rector Checkstyle
+
+on: [push]
+
+jobs:
+  tests:
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: [ ubuntu-latest ]
+        php-versions: ['7.4']
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Setup PHP, with composer and extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: json, mbstring, openssl
+          coverage: none
+
+      - name: Install Composer dependencies
+        run: composer update --no-progress --no-suggest --prefer-dist --optimize-autoloader
+
+      - name: Rector
+        run: make rector

.github/workflows/static-analyze.yml

@@ -0,0 +1,32 @@
+name: Static Analyze
+
+on: [push]
+
+jobs:
+  tests:
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: [ubuntu-latest]
+        php-versions: ['7.4']
+    name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Setup PHP, with composer and extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: json, mbstring, openssl
+          coverage: xdebug
+
+      - name: Install Composer dependencies
+        run: |
+          composer update --no-progress --no-suggest --prefer-dist --optimize-autoloader
+
+      - name: PHPStan
+        run: make static-analyse

.github/workflows/tests.yml

@@ -0,0 +1,32 @@
+name: Unit and Functional Tests
+
+on: [push]
+
+jobs:
+  tests:
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: [ ubuntu-latest ]
+        php-versions: ['7.3', '7.4', '8.0', '8.1']
+    name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Setup PHP, with composer and extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: json, mbstring, openssl
+          coverage: xdebug
+
+      - name: Install Composer dependencies
+        run: |
+          composer update --no-progress --no-suggest --prefer-dist --optimize-autoloader
+
+      - name: Run tests
+        run: make tests

.gitignore

@@ -1,3 +1,5 @@
 /vendor/
 /composer.lock
-/*cache
+/*cache
+/build
+/infection.log