diff --git a/.gitattributes b/.gitattributes index 15b8fe602d9bda9a7bb8ea7a6664dad46ce50f81..cea09fccdf7c684b0c3a5135ae68018a3f159d0d 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,11 +1,16 @@ * text=auto +/.github export-ignore /doc export-ignore /tests export-ignore /.gitattributes export-ignore -/.github export-ignore /.gitignore export-ignore +/CODE_OF_CONDUCT.md export-ignore /ecs.php export-ignore -/rector.php export-ignore +/infection.json.dist export-ignore +/Makefile export-ignore +/phpstan.neon export-ignore /phpunit.xml.dist export-ignore /README.md export-ignore +/rector.php export-ignore +/SECURITY.md export-ignore diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ecc429e1b72aa2d5f45b3634b1d5b14fea056d99..2b7c6aaa23db70c557a54a3c50e7ad45d8b1f7fd 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,16 +1,27 @@ -# Aux contributeurs +# Contributing -Tout d’abord, **merci** pour votre contribution. +First of all, **thank you** for contributing. -Les bogues ou les demandes de fonctionnalités peuvent être publiés en ligne dans la section des problèmes GitHub du projet. +Bugs or feature requests can be posted online on the GitHub issues section of the project. -Quelques règles pour faciliter les revues de code et les fusions : +Few rules to ease code reviews and merges: -- Vous DEVEZ suivre le [PSR-1](http://www.php-fig.org/psr/psr-1/), [PSR-2](http://www.php-fig.org/psr /psr-2/) et [PSR-4](http://www.php-fig.org/psr/psr-4/). -- Vous DEVEZ exécuter la suite de tests. -- Vous DEVEZ écrire (ou mettre à jour) des tests lorsque des bogues sont corrigés ou que des fonctionnalités sont ajoutées. -- Vous DEVRIEZ rédiger de la documentation. +- You MUST follow the [PSR-12](http://www.php-fig.org/psr/psr-12/) coding standards. +- You MUST run the test suite. +- You MUST write (or update) unit tests when bugs are fixed or features are added. +- You SHOULD write documentation. -[Git-Flow](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/) est vivement recommandé. +To contribute use [Pull Requests](https://help.github.com/articles/using-pull-requests), please, write commit messages that make sense, and rebase your branch before submitting your PR. -Merci de mettre à jour votre dépôt avant de soumettre votre Pull Request. +May be asked to squash your commits too. This is used to "clean" your Pull Request before merging it, avoiding commits such as fix tests, fix 2, fix 3, etc. + +Run test suite +------------ + +* install composer: `curl -s http://getcomposer.org/installer | php` +* install dependencies: `php composer.phar install` +* run tests: `vendor/bin/phpunit` +* check and fix coding standards: + * `vendor/bin/phpstan analyse` + * `vendor/bin/rector process` + * `vendor/bin/ecs check --fix` diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000000000000000000000000000000000000..726574c1f662e3cbaf1160472c9cffbd21e7439e --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: Spomky +patreon: FlorentMorselli diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 2ceb8da6a9665452157ddf037a0b11d2171995ce..0000000000000000000000000000000000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,16 +0,0 @@ -| Q | A -| -------------------- | ----- -| Bug report? | yes/no -| Feature request? | yes/no -| BC Break report? | yes/no -| RFC? / Specification | yes/no -| Library version | x.y(.z) - -<!-- -Fill in this template according to your issue. -Otherwise, replace this comment by the description of your issue. - -Please consider the following requirements -* You MUST never send security issues here. If you think that your issue is a security one then contact Spomky in private at https://gitter.im/Spomky/ -* You should not post many lines of source code or console logs. Small inputs (approx 5 lines) are acceptable otherwize you should use a third party service (e.g. Pastebin, Chop...). ---> diff --git a/.github/ISSUE_TEMPLATE/1_Bug_report.md b/.github/ISSUE_TEMPLATE/1_Bug_report.md index fca7e51ad4167b41c7f40a2ce9c13db4904f8d8e..3a3e9fd4de1db2988c87fc7e1395ed435288ccc4 100644 --- a/.github/ISSUE_TEMPLATE/1_Bug_report.md +++ b/.github/ISSUE_TEMPLATE/1_Bug_report.md @@ -1,21 +1,21 @@ --- name: 🛠Bug Report -about: âš ï¸ For all bug reports except security issues (see below) -labels: bug +about: âš ï¸ See below for security reports +labels: Bug --- -**Version(s)** : x.y.z +**Version(s) affected**: x.y.z **Description** <!-- A clear and concise description of the problem. --> -**How to reproduce?** -<!-- Code or configuration needed to reproduce the problem. If it is a complex bug, - create a "bug reproducer" --> +**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 any suggestions on a fix/bug reason --> +**Possible Solution** +<!--- Optional: only if you have suggestions on a fix/reason for the bug --> **Additional context** -<!-- Optional: any other context regarding the issue: log messages, screenshots, etc. --> +<!-- Optional: any other context about the problem: log messages, screenshots, etc. --> diff --git a/.github/ISSUE_TEMPLATE/2_Feature_request.md b/.github/ISSUE_TEMPLATE/2_Feature_request.md index 70a8ac072d049bcfc3542b33b0f75ab69a9fcb0a..8ffd9746dfbf5789e756309c107eb881a8aa6a52 100644 --- a/.github/ISSUE_TEMPLATE/2_Feature_request.md +++ b/.github/ISSUE_TEMPLATE/2_Feature_request.md @@ -1,7 +1,6 @@ --- -name: 🎉 Feature request +name: 🚀 Feature Request about: Ideas for new features and improvements -labels: feature --- @@ -9,5 +8,5 @@ labels: feature <!-- A clear and concise description of the new feature. --> **Example** -<!-- A simple example of the new feature in action (include PHP code, YAML configuration, etc.) - If the new feature changes an existing feature, include a before/after comparison. --> \ No newline at end of file +<!-- 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. --> diff --git a/.github/ISSUE_TEMPLATE/3_Documentation_issue.md b/.github/ISSUE_TEMPLATE/3_Documentation_issue.md deleted file mode 100644 index 387d7c145263108a4dc7552cd4ddbd21d46856f6..0000000000000000000000000000000000000000 --- a/.github/ISSUE_TEMPLATE/3_Documentation_issue.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: 📖 Documentation issue -about: If a typo or section is out of date -labels: documentation - ---- - -**Affected page** -<!-- Indicate the page (link or specific area) that needs to be corrected. --> - -**What is written** -<!-- Copy/Paste from the concerned section. --> - -**What should be written** -<!-- Your proposed correction. --> \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/3_Support_question.md b/.github/ISSUE_TEMPLATE/3_Support_question.md new file mode 100644 index 0000000000000000000000000000000000000000..6b4f0609aeaf4356e78e7f85f796b9aebf7f134b --- /dev/null +++ b/.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 bugs and new features. +For this kind of questions about using the library or the bundle, please use +https://stackoverflow.com/ using the tags `[aes]` and `[php]` + +Thanks! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/4_Documentation_issue.md b/.github/ISSUE_TEMPLATE/4_Documentation_issue.md new file mode 100644 index 0000000000000000000000000000000000000000..26cd199c1df604f880c14ea1f58e7ca0e5bea21f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4_Documentation_issue.md @@ -0,0 +1,5 @@ +--- +name: 📖 Documentation Issue +about: To report typo or obsolete section in the documentation + +--- diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 68ac3b4dc0f4b0bbbf3f7a394c2defd3a1b1bbb9..1beb0a38bf47c49a64411a94f142854476051755 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,19 @@ -| Q | A -| ----------------------- | --- -| Correction de bogues? | oui/non -| Nouvelle fonctionnalité | oui/non -| Dépréciations? | oui/non -| Tickets | Corrige #... +| Q | A +| ------------- | --- +| 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 <!-- -Remplacez cet avis par un court README pour votre fonctionnalité/correction de bogues. Cela aidera les autres à -comprendre votre PR. Cela peut être utilisé comme point de départ pour la documentation. +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. -En outre: - - Ajoutez toujours des tests et assurez-vous qu’ils réussissent. - - Ne jamais rompre la rétrocompatibilité, sauf si c’est l’objet de votre PR. - - Votre dépôt doit être à jour. ---> +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). +--> \ No newline at end of file diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000000000000000000000000000000000000..75436e42b0ab812b010b6dd6900713672891f104 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,8 @@ +version: 2 +updates: +- package-ecosystem: composer + directory: "/" + schedule: + interval: daily + time: "11:00" + open-pull-requests-limit: 10 diff --git a/SECURITY.md b/SECURITY.md index 3c21578c62b8a12f1a4fdc46be3ffb2de76e3b43..706ad9a323cafbb8bc797f500d4365b2e73a8b9f 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,16 +2,15 @@ ## Supported Versions - -| Version | Supported | -| ------- | ------------------ | -| 11.0.x | :white_check_mark: | -| 10.0.x | :white_check_mark: | -| < 10.0 | :x: | +| Version | Supported | +| ------- |----------------------------------------| +| 11.0.x | :white_check_mark: | +| 10.0.x | :white_check_mark: (security fix only) | +| < 10.0 | :x: | ## Reporting a Vulnerability -Please send an email to `security@spomky-labs.com`. +Please email `security@spomky-labs.com`. If deemed necessary, you can encrypt your message using one of the following GPG key ```