Commit 99ffb26d authored by Florent Morselli's avatar Florent Morselli
Browse files

Few doc pages

Showing with 89 additions and 76 deletions
+89 -76
* text=auto * text=auto
/.github export-ignore
/doc export-ignore /doc export-ignore
/tests export-ignore /tests export-ignore
/.gitattributes export-ignore /.gitattributes export-ignore
/.github export-ignore
/.gitignore export-ignore /.gitignore export-ignore
/CODE_OF_CONDUCT.md export-ignore
/ecs.php 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 /phpunit.xml.dist export-ignore
/README.md export-ignore /README.md export-ignore
/rector.php export-ignore
/SECURITY.md export-ignore
# 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/). - You MUST follow the [PSR-12](http://www.php-fig.org/psr/psr-12/) coding standards.
- Vous DEVEZ exécuter la suite de tests. - You MUST run the test suite.
- Vous DEVEZ écrire (ou mettre à jour) des tests lorsque des bogues sont corrigés ou que des fonctionnalités sont ajoutées. - You MUST write (or update) unit tests when bugs are fixed or features are added.
- Vous DEVRIEZ rédiger de la documentation. - 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`
github: Spomky
patreon: FlorentMorselli
| 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...).
-->
--- ---
name: 🐛 Bug Report name: 🐛 Bug Report
about: ⚠️ For all bug reports except security issues (see below) about: ⚠️ See below for security reports
labels: bug labels: Bug
--- ---
**Version(s)** : x.y.z **Version(s) affected**: x.y.z
**Description** **Description**
<!-- A clear and concise description of the problem. --> <!-- A clear and concise description of the problem. -->
**How to reproduce?** **How to reproduce**
<!-- Code or configuration needed to reproduce the problem. If it is a complex bug, <!-- Code and/or config needed to reproduce the problem. If it's a complex bug,
create a "bug reproducer" --> create a "bug reproducer" as explained in: -->
**Possible solution** **Possible Solution**
<!--- Optional: only if you have any suggestions on a fix/bug reason --> <!--- Optional: only if you have suggestions on a fix/reason for the bug -->
**Additional context** **Additional context**
<!-- Optional: any other context regarding the issue: log messages, screenshots, etc. --> <!-- Optional: any other context about the problem: log messages, screenshots, etc. -->
--- ---
name: 🎉 Feature request name: 🚀 Feature Request
about: Ideas for new features and improvements about: Ideas for new features and improvements
labels: feature
--- ---
...@@ -9,5 +8,5 @@ labels: feature ...@@ -9,5 +8,5 @@ labels: feature
<!-- A clear and concise description of the new feature. --> <!-- A clear and concise description of the new feature. -->
**Example** **Example**
<!-- A simple example of the new feature in action (include PHP code, YAML configuration, etc.) <!-- 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 before/after comparison. --> If the new feature changes an existing feature, include a simple before/after comparison. -->
\ No newline at end of file
---
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
---
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
---
name: 📖 Documentation Issue
about: To report typo or obsolete section in the documentation
---
| Q | A | Q | A
| ----------------------- | --- | ------------- | ---
| Correction de bogues? | oui/non | Branch? | <!-- see below -->
| Nouvelle fonctionnalité | oui/non | Bug fix? | yes/no
| Dépréciations? | oui/non | New feature? | yes/no <!-- please update src/**/CHANGELOG.md files -->
| Tickets | Corrige #... | 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 à Replace this notice by a short README for your feature/bugfix. This will help people
comprendre votre PR. Cela peut être utilisé comme point de départ pour la documentation. understand your PR and can be used as a start for the documentation.
En outre: Additionally:
- Ajoutez toujours des tests et assurez-vous qu’ils réussissent. - Always add tests and ensure they pass.
- Ne jamais rompre la rétrocompatibilité, sauf si c’est l’objet de votre PR. - Never break backward compatibility (unless you are working on the next major release branch).
- Votre dépôt doit être à jour. - 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
version: 2
updates:
- package-ecosystem: composer
directory: "/"
schedule:
interval: daily
time: "11:00"
open-pull-requests-limit: 10
...@@ -2,16 +2,15 @@ ...@@ -2,16 +2,15 @@
## Supported Versions ## Supported Versions
| Version | Supported |
| Version | Supported | | ------- |----------------------------------------|
| ------- | ------------------ | | 11.0.x | :white_check_mark: |
| 11.0.x | :white_check_mark: | | 10.0.x | :white_check_mark: (security fix only) |
| 10.0.x | :white_check_mark: | | < 10.0 | :x: |
| < 10.0 | :x: |
## Reporting a Vulnerability ## 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 If deemed necessary, you can encrypt your message using one of the following GPG key
``` ```
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment