Guide de contribution

Rapports de bogue

Nous vous remercions de nous aider à tester ZEDx. Nous sommes heureux de vous avoir dans l'équipe! Nous avons besoin de gens qui peuvent résoudre les problèmes patiemment et les exprimer clairement. Comme vous le savez sans doute, un bon rapport de bogue prend un certain temps et nécessite pas mal d'efforts. Si vous êtes à l'aise, alors vous pouvez commencer!

Vous avez déjà trouvé un bogue? Formidable! Nous aimerions en entendre parler — mais d'abord vous devrez vous assurer que vous n'êtes pas en train de perdre votre temps sur un problème déjà connu:

  • Rechercher sur le forum d'aide pour voir si le bogue n'a pas déjà été signalé.
  • Nous pourrions déjà travailler sur un correctif, donc chercher aussi sur notre traqueur d'erreur.

Si vous avez effectué une recherche approfondie et n'avez rien trouvé, votre rapport est le bienvenu. Si c'est juste une petite erreur (un mot mal orthographié ou une anomalie graphique, par exemple) passer au paragraphe suivant. Par contre, si vous voyez des erreurs, ou quelque chose qui est clairement cassé nous aurons besoin d'abord d'informations. S'il vous plaît, rendez-vous sur notre guide Dépannage et suivez ses instructions. Recueillez autant d'informations que vous pouvez!

Parfait, il est temps de passer à l'écriture. Retournez sur le forum de soutien et commencez une nouvelle discussion. Assurez-vous de lui donner un titre clair et concis, ensuite expliquez en détail le problème. Ne pas oublier de mentionner:

  • Qu'est-ce que vous faisiez lorsque le problème est survenu
  • Toutes les informations recueillies pendant le dépannage
  • Tout ce que vous pouvez nous dire de votre environnement serveur

Rappelez-vous: l'objectif d'un rapport de bogue est que nous puissions reproduire le bogue et le corriger. Vous pouvez lire cet article qui énumère quelques conseils utiles sur la façon d'écrire un rapport de bogue efficace. Et s'il vous plaît , prenez votre temps pour rédiger votre message de sorte qu'il soit facile de comprendre de quoi il s'agit.

Une fois que vous avez posté votre rapport, nous vous demandons s'il vous plaît de suivre la discussion que vous avez créée et t'attendre patiemment. Nous pouvons avoir besoin de vous demander des précisions ou des éclaircissements; mais nous avons toujours beaucoup à faire, et il peut se passer un certain temps avant que nous puissions consacrer le temps nécessaire à votre rapport.

Recommandations Pull Request

Faille de sécurité

Si vous découvrez une faille de sécurité au sein de ZEDx, s'il vous plaît envoyer un e-mail à security@zedx.io. Toutes les failles de sécurité seront traitées rapidement.

Style du code

ZEDx suit le standard de code PSR-2 et le standard automatique PSR-4.

PHPDoc

Voici un exemple valide d'un bloc de documentation ZEDx. Notez que l'attribut @param est suivi par deux espaces, le type d'argument, deux autres espaces, et enfin le nom de la variable:

/**
 * Register a binding with the container.
 *
 * @param  string|array  $abstract
 * @param  \Closure|string|null  $concrete
 * @param  bool  $shared
 * @return void
 */
public function bind($abstract, $concrete = null, $shared = false)
{
    //
}

StyleCI

Si votre style du code n'est pas parfait, ne vous inquiétez pas! StyleCI fusionnera automatiquement les corrections du style dans le dépôt de ZedX lorsque tous les pull requests seront validés. Cela vous permet de vous concentrez sur le contenu de la contribution et non sur le style du code.