-
-
Notifications
You must be signed in to change notification settings - Fork 155
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
38 changed files
with
949 additions
and
618 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,16 @@ | ||
# Contributing | ||
# Aux contributeurs | ||
|
||
First of all, **thank you** for contributing. | ||
Tout d’abord, **merci** pour votre contribution. | ||
|
||
Bugs or feature requests can be posted online on the GitHub issues section of the project. | ||
Les bogues ou les demandes de fonctionnalités peuvent être publiés en ligne dans la section des problèmes GitHub du projet. | ||
|
||
Few rules to ease code reviews and merges: | ||
Quelques règles pour faciliter les revues de code et les fusions : | ||
|
||
- You MUST follow the [PSR-1](http://www.php-fig.org/psr/psr-1/), [PSR-2](http://www.php-fig.org/psr/psr-2/) and [PSR-4](http://www.php-fig.org/psr/psr-4/) 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. | ||
- 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. | ||
|
||
We use [Git-Flow](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/) to automate our git branching workflow. | ||
[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. | ||
|
||
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` | ||
Merci de mettre à jour votre dépôt avant de soumettre votre Pull Request. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
name: 🐛 Bug Report | ||
about: ⚠️ For all bug reports except security issues (see below) | ||
labels: bug | ||
|
||
--- | ||
|
||
**Version(s)** : 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" --> | ||
|
||
**Possible solution** | ||
<!--- Optional: only if you have any suggestions on a fix/bug reason --> | ||
|
||
**Additional context** | ||
<!-- Optional: any other context regarding the issue: log messages, screenshots, etc. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
name: 🎉 Feature request | ||
about: Ideas for new features and improvements | ||
labels: feature | ||
|
||
--- | ||
|
||
**Description** | ||
<!-- 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. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
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. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Support Question | ||
url: https://spomky-labs.com/contact/ | ||
about: We use GitHub issues only to discuss about bugs and new features. For this kind of questions about using the library, please use Stackoverflow (or similar) or send a quote request at https://spomky-labs.com/contact/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,15 @@ | ||
| Q | A | ||
| ------------- | --- | ||
| Branch? | master | ||
| Bug fix? | yes/no | ||
| New feature? | yes/no | ||
| BC breaks? | yes/no | ||
| Deprecations? | yes/no | ||
| Tests pass? | yes/no | ||
| Fixed tickets | #... <!-- #-prefixed issue number(s), if any --> | ||
| License | MIT | ||
| Tests added | <!--highly recommended for new features--> | ||
| Doc PR | <!--highly recommended for new features--> | ||
|
||
| Q | A | ||
| ----------------------- | --- | ||
| Correction de bogues? | oui/non | ||
| Nouvelle fonctionnalité | oui/non | ||
| Dépréciations? | oui/non | ||
| Tickets | Corrige #... | ||
<!-- | ||
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. | ||
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. | ||
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/ | ||
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. | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,8 @@ | ||
# Number of days of inactivity before an issue becomes stale | ||
daysUntilStale: 60 | ||
# Number of days of inactivity before a stale issue is closed | ||
daysUntilClose: 7 | ||
# Issues with these labels will never be considered stale | ||
exemptLabels: | ||
- pinned | ||
- security | ||
# Label to use when marking an issue as stale | ||
staleLabel: wontfix | ||
# Comment to post when marking an issue as stale. Set to `false` to disable | ||
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. | ||
# Comment to post when closing a stale issue. Set to `false` to disable | ||
Ce problème a été automatiquement marqué comme périmé car il n'a pas eu | ||
d’activité récente. Il sera fermé dans 7 jours si aucune autre activité ne se produit. Merci | ||
pour votre contribution. | ||
closeComment: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
name: Coding Standards | ||
|
||
on: [push] | ||
|
||
jobs: | ||
tests: | ||
runs-on: ${{ matrix.operating-system }} | ||
strategy: | ||
matrix: | ||
operating-system: [ubuntu-latest] | ||
php-versions: ['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: mbstring | ||
coverage: xdebug | ||
|
||
- name: Install the application | ||
run: | | ||
composer install --no-progress --prefer-dist --optimize-autoloader | ||
yarn install --force | ||
yarn build | ||
- name: Coding Standards Checks | ||
run: make ci-cs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
name: Mutation Testing | ||
|
||
on: [push] | ||
|
||
jobs: | ||
tests: | ||
runs-on: ${{ matrix.operating-system }} | ||
strategy: | ||
matrix: | ||
operating-system: [ubuntu-latest] | ||
php-versions: ['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: mbstring | ||
coverage: xdebug | ||
|
||
- name: Install the application | ||
run: | | ||
composer install --no-progress --prefer-dist --optimize-autoloader | ||
yarn install --force | ||
yarn build | ||
- name: Fetch Git base reference | ||
run: git fetch --depth=1 origin $GITHUB_BASE_REF | ||
|
||
- name: Infection | ||
run: make ci-mu |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
name: Rector Checkstyle | ||
|
||
on: [push] | ||
|
||
jobs: | ||
tests: | ||
runs-on: ${{ matrix.operating-system }} | ||
strategy: | ||
matrix: | ||
operating-system: [ ubuntu-latest ] | ||
php-versions: ['8.0', '8.1'] | ||
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: mbstring | ||
coverage: none | ||
|
||
- name: Install the application | ||
run: | | ||
composer install --no-progress --prefer-dist --optimize-autoloader | ||
yarn install --force | ||
yarn build | ||
- name: Rector | ||
run: make ci-rector |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
name: Static Analyze | ||
|
||
on: [push] | ||
|
||
jobs: | ||
tests: | ||
runs-on: ${{ matrix.operating-system }} | ||
strategy: | ||
matrix: | ||
operating-system: [ubuntu-latest] | ||
php-versions: ['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: mbstring | ||
coverage: xdebug | ||
tools: cs2pr | ||
|
||
- name: Install the application | ||
run: | | ||
composer install --no-progress --prefer-dist --optimize-autoloader | ||
yarn install --force | ||
yarn build | ||
- name: Static Analyze Checks | ||
run: make ci-st |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
name: Unit and Functional Tests | ||
|
||
on: [push] | ||
|
||
jobs: | ||
tests: | ||
runs-on: ${{ matrix.operating-system }} | ||
strategy: | ||
matrix: | ||
operating-system: [ ubuntu-latest ] | ||
php-versions: ['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: mbstring | ||
coverage: xdebug | ||
|
||
- name: Install the application | ||
run: | | ||
composer install --no-progress --prefer-dist --optimize-autoloader | ||
yarn install --force | ||
yarn build | ||
- name: Run tests | ||
run: make all |
Oops, something went wrong.