diff options
| author | 2021-10-23 13:43:24 +0200 | |
|---|---|---|
| committer | 2021-10-23 13:43:24 +0200 | |
| commit | acbba9adb2e362079ce1fb84be1868b198cc1da0 (patch) | |
| tree | eeeaa9e522f82a9f8f9baaef3b6bd23950eab71a /docs/fr/contributing.md | |
| parent | dd02c79092aa25cacff1c831815e9ca02b06b620 (diff) | |
Improved markdownlint (#3918)
* Improved markdownlint
* Relaxed rules slighlty
* `npm run markdownlint` for automatic tests
* `npm run markdownlint_fix` for automatic syntax fixing
* Applied the fixes on all our Markdown files
Diffstat (limited to 'docs/fr/contributing.md')
| -rw-r--r-- | docs/fr/contributing.md | 53 |
1 files changed, 22 insertions, 31 deletions
diff --git a/docs/fr/contributing.md b/docs/fr/contributing.md index bb67db304..966393849 100644 --- a/docs/fr/contributing.md +++ b/docs/fr/contributing.md @@ -4,11 +4,10 @@ S'il vous manque des informations, n'hésitez pas à fouiller un peu la documentation ou venir nous poser directement vos questions sur [la mailing list des développeurs](https://freshrss.org/mailman/listinfo/dev). -* Le premier mailing est destiné à l'information générique, il doit être - adapté aux utilisateurs. [Rejoignez - mailing@freshrss.org](https://freshrss.org/mailman/listinfo/mailing). -* Le deuxième mailing s'adresse principalement aux développeurs. [Rejoignez - dev@freshrss.org](https://freshrss.org/mailman/listinfo/dev) +* Le premier mailing est destiné à l'information générique, il doit être adapté aux utilisateurs. + [Rejoignez mailing@freshrss.org](https://freshrss.org/mailman/listinfo/mailing). +* Le deuxième mailing s'adresse principalement aux développeurs. + [Rejoignez dev@freshrss.org](https://freshrss.org/mailman/listinfo/dev) ## Signaler un bug @@ -16,47 +15,39 @@ Avez-vous trouvé un bogue ? Ne paniquez pas, voici quelques étapes pour le signaler facilement : 1. Cherche sur [le bug tracker](https://github.com/FreshRSS/FreshRSS/issues) - (n'oubliez pas d'utiliser la barre de recherche). + (n'oubliez pas d'utiliser la barre de recherche). 2. Si vous constatez un bogue similaire, n'hésitez pas à poster un - commentaire pour ajouter de l'importance au ticket correspondant. -3. Si vous ne l'avez pas trouvé, [ouvrez un nouveau - ticket](https://github.com/FreshRSS/FreshRSS/issues/new). + commentaire pour ajouter de l'importance au ticket correspondant. +3. Si vous ne l'avez pas trouvé, + [ouvrez un nouveau ticket](https://github.com/FreshRSS/FreshRSS/issues/new). Si vous devez créer un nouveau ticket, essayez de garder les conseils suivants : -* Donnez un titre explicite au ticket pour le retrouver plus facilement plus - tard. -* Soyez aussi exhaustif que possible dans la description : qu'avez-vous fait - ? Quel est le bogue ? Quelles sont les étapes pour reproduire le bogue ? +* Donnez un titre explicite au ticket pour le retrouver plus facilement plus tard. +* Soyez aussi exhaustif que possible dans la description : qu'avez-vous fait ? + Quel est le bogue ? Quelles sont les étapes pour reproduire le bogue ? Nous avons aussi besoin de quelques informations : -* Votre version de FreshRSS (sur la page A propos) ou le fichier - `constants.php`) +* Votre version de FreshRSS (sur la page A propos) ou le fichier `constants.php`) * Votre configuration de serveur : type d'hébergement, version PHP -* Quelle base de données : SQLite, MySQL, MariaDB, PostgreSQL ? Quelle - version ? -* Si possible, les logs associés (logs PHP et logs FreshRSS sous - `data/users/your_user/log.txt`) +* Quelle base de données : SQLite, MySQL, MariaDB, PostgreSQL ? Quelle version ? +* Si possible, les logs associés (logs PHP et logs FreshRSS sous `data/users/your_user/log.txt`) ## Corriger un bogue Voulez-vous corriger un bogue ? Pour maintenir une grande coordination entre les collaborateurs, vous devrez suivre ces indications : -1. Assurez-vous que le bogue est associé à un ticket et indiquez que vous - allez travailler sur le bogue. -2. [Fork du répertoire de - projet](https://help.github.com/articles/fork-a-repo/). -3. [Créez une nouvelle - branche](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/). - Le nom de la branche doit être clair, et idéalement préfixé par - l'identifiant du ticket correspondant. Par exemple, - `783-contributing-file` pour réparer [ticket - #783](https://github.com/FreshRSS/FreshRSS/issues/783). -4. Ajoutez vos modifications à votre fork et [ouvrez une demande de pull - request](https://help.github.com/articles/using-pull-requests/). +1. Assurez-vous que le bogue est associé à un ticket et indiquez que vous allez travailler sur le bogue. +2. [Fork du répertoire de projet](https://help.github.com/articles/fork-a-repo/). +3. [Créez une nouvelle branche](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/). + Le nom de la branche doit être clair, et idéalement préfixé par l'identifiant du ticket correspondant. + Par exemple, `783-contributing-file` pour réparer + [ticket #783](https://github.com/FreshRSS/FreshRSS/issues/783). +4. Ajoutez vos modifications à votre fork et + [ouvrez une demande de pull request](https://help.github.com/articles/using-pull-requests/). Si vous devez écrire du code, veuillez suivre [nos recommandations de style de codage](developers/01_First_steps.md). |
