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.
- Le premier mailing est destiné à l'information générique, il doit être adapté aux utilisateurs. Rejoignez [email protected].
- Le deuxième mailing s'adresse principalement aux développeurs. Rejoignez [email protected]
Avez-vous trouvé un bogue ? Ne paniquez pas, voici quelques étapes pour le signaler facilement :
- Cherche sur le bug tracker (n'oubliez pas d'utiliser la barre de recherche).
- Si vous constatez un bogue similaire, n'hésitez pas à poster un commentaire pour ajouter de l'importance au ticket correspondant.
- Si vous ne l'avez pas trouvé, ouvrez un nouveau ticket.
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 ?
Nous avons aussi besoin de quelques informations :
- 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
)
Voulez-vous corriger un bogue ? Pour maintenir une grande coordination entre les collaborateurs, vous devrez suivre ces indications :
- Assurez-vous que le bogue est associé à un ticket et indiquez que vous allez travailler sur le bogue.
- Fork du répertoire de projet.
- Créez une nouvelle
branche.
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. - Ajoutez vos modifications à votre fork et ouvrez une demande de pull request.
Si vous devez écrire du code, veuillez suivre nos recommandations de style de codage.
**Conseil : **si vous cherchez des bugs faciles à corriger, jetez un coup d'oeil à la vignette "good first issue".
Vous avez de bonnes idées, oui ! Ne soyez pas timide et ouvrez un nouveau ticket sur notre tracker bogue pour nous demander si nous pouvons le mettre en œuvre. Les plus grandes idées viennent souvent des suggestions les plus timides !
Si votre idée est bonne, nous y jetterons un coup d'oeil.
Si vous voulez améliorer l'internationalisation, ouvrez d'abord un nouveau ticket et suivez les conseils de la section Fixer un bogue.
Les traductions sont disponibles dans les sous-répertoires de ./app/i18n/
.
Nous travaillons sur une meilleure façon de gérer l'internationalisation mais n'hésitez pas à nous suggérer des idées !
Il ne vous aura pas échappé que la documentation est encore un peu vide… il y a énormément de choses à faire ! Si vous souhaitez aider à écrire quelques pages, rendez-vous dans les principaux dépôtsfichier docs !