Créer une issue

Quelques règles pour proposer à la communauté vos modifications, vos nouvelles fonctionnalités et vos corrections sur mviewer.

Règle générale

Toute modification du cœur de mviewer doit être proposée à l’aide d’une nouvelle issue sur le Github mviewer/mviewer.

Pourquoi créer une issue ?

D’abord, pour pouvoir intégrer votre modification dans le cœur et maîtriser la maintenance des sources. Si vous modifiez le cœur mviewer de votre instance et que vous souhaitez réaliser une mise à jour, vous aller devoir gérer des conflits. Ce qui ne sera pas le cas si vos modifications sont déjà dans le code de la nouvelle version.

Ensuite, pour vous éviter de réaliser une demande de contribution qui ne sera pas acceptée lors de la revue :

  • Le code proposé ne respecte pas le formatage initial.

  • Vous avez réalisé une contribution qui existe déjà.

  • Vous proposez un code avec un niveau de complexité trop élevé.

  • Le fonctionnement ou le code doivent être optimisés.

  • Une partie de ce que vous proposez fonctionne mais ne peut pas être intégrée (dépendances externes non maintenues, mauvaise utilisation du langage, etc…).

  • Votre contribution ne peut pas être intégrée dans le cœur, car vous seul en avez l’utilisation.

Il y a également d’autres bonnes raisons de créer une issue pour contribuer :

  • Partager votre idée et vous aurez probablement des personnes pour la réaliser (intéressant !).

  • Avertir d’autres contributeurs que vous travaillez sur un sujet et mutualiser le travail.

  • Eviter que plusieurs contributeurs travaillent en parallèle sur la même chose.

  • Permettre d’obtenir des informations pour réaliser ce que vous souhaitez.

  • Obtenir un avis ou de l’aide sur une idée de contribution et la manière de la réaliser.

Où créer une issue ?

Il faudra vous rendre sur la page GitHub mviewer. Vous devez disposer d’un compte et vous connecter.

Cliquer ensuite sur « Issue » puis, « New issue ».

Comment créer une issue ?

1 - Donner un titre

Le titre doit être court mais explicite. Le titre doit permettre de retrouver facilement votre issue à la lecture.

  • Bon : « Ajouter un boutton “Nouvelle issue” »

  • Mauvais : « Ajouter un nouveau boutton pour créer une issue aujourd’hui manquant »

2 - Ajouter la description

Il sera obligatoire de formater votre texte grâce au Markdown afin de faciliter la lecture. Notamment pour citer ou mettre en évidence des morceaux de code. Autrement, votre texte risque d’être vite illisible. Voici un exemple de syntaxe Makrdown.

La description peut contenir des images, des liens, des citations ou des morceaux de code.

3 - Surveiller les réponses

Soyez animateur de votre discussion et participez dans les réponses. Sinon, elle sera vite oubliée… Pour citer une personne, utilisez @identifiant_Github. Elle sera avertie par email de votre message.

Qui peux créer une issue ?

Tout le monde peut créer une issue à condition de disposer d’un compte GitHub (gratuit).