Codage-starter-projets
Un référentiel de base pour partager vos projets de démarrage avec les autres et les aider à grandir également!
Tout d'abord, merci d'avoir pris le temps de contribuer!
Tous les types de contributions sont encouragés et appréciés. Voir la table des matières pour différentes façons d'aider et de détails sur la façon dont ce projet les gère. Veuillez vous assurer de lire la section pertinente avant de faire votre contribution. Cela facilitera beaucoup les responsables et lissera l'expérience pour toutes les personnes impliquées. La communauté attend avec impatience vos contributions.
Et si vous aimez le projet, mais que vous n'avez tout simplement pas le temps de contribuer, c'est bien. Il existe d'autres moyens faciles de soutenir le projet et de montrer votre appréciation, ce dont nous serions également très heureux:
- Strer le projet
- Tweeter à ce sujet
- Reportez-vous à ce projet dans Readme de votre projet
- Mentionnez le projet lors des rencontres locales et dites à vos amis / collègues
Table des matières
- Code de conduite
- J'ai une question
- Je veux contribuer
- Rapports de bugs
- Suggérant des améliorations
Code de conduite
Ce projet et tous ceux qui y participent sont régis par le code de conduite contribuant. En participant, vous devez maintenir ce code. Veuillez signaler un comportement inacceptable à <>.
J'ai une question
Si vous souhaitez poser une question, nous supposons que vous avez lu la documentation disponible.
Avant de poser une question, il est préférable de rechercher des problèmes existants qui pourraient vous aider. Dans le cas où vous avez trouvé un problème approprié et vous avez encore besoin de clarification, vous pouvez écrire votre question dans ce numéro. Il est également conseillé de rechercher d'abord les réponses sur Internet.
Si vous ressentez alors le besoin de poser une question et de nécessiter des éclaircissements, nous recommandons ce qui suit:
- Ouvrez un problème.
- Fournissez autant de contexte que possible sur ce que vous rencontrez.
- Fournir des versions de projet et de plate-forme (NodeJS, NPM, etc.), selon ce qui semble pertinent.
Nous nous occuperons ensuite du problème dès que possible.
Je veux contribuer
Avis juridique
Lorsque vous contribuez à ce projet, vous devez convenir que vous avez l'auteur de 100% du contenu, que vous avez les droits nécessaires sur le contenu et que le contenu que vous contribuez peut être fourni en vertu de la licence de projet.
Rapports de bugs
Avant de soumettre un rapport de bogue
Un bon rapport de bogue ne devrait pas laisser les autres qui doivent vous poursuivre pour plus d'informations. Par conséquent, nous vous demandons d'enquêter attentivement, de collecter des informations et de décrire le problème en détail dans votre rapport. Veuillez suivre les étapes suivantes à l'avance pour nous aider à résoudre tout bogue potentiel le plus rapidement possible.
- Assurez-vous que vous utilisez la dernière version.
- Déterminez si votre bogue est vraiment un bug et non une erreur de votre côté, par exemple en utilisant des composants / versions d'environnement incompatibles (assurez-vous que vous avez lu la documentation. Si vous recherchez un support, vous voudrez peut-être vérifier cette section).
- Pour voir si d'autres utilisateurs ont connu (et potentiellement déjà résolu) le même problème que vous rencontrez, vérifiez s'il n'y a pas déjà de rapport de bogue existant pour votre bug ou votre erreur dans le tracker de bogue.
- Assurez-vous également de rechercher sur Internet (y compris le débordement de pile) pour voir si les utilisateurs en dehors de la communauté GitHub ont discuté du problème.
- Collectez des informations sur le bogue:
- Trace de pile (traceback)
- OS, plate-forme et version (Windows, Linux, MacOS, x86, ARM)
- Version de l'interprète, du compilateur, du SDK, de l'environnement d'exécution, du gestionnaire de packages, selon ce qui semble pertinent.
- Peut-être votre entrée et la sortie
- Pouvez-vous reproduire de manière fiable le problème? Et pouvez-vous également le reproduire avec des versions plus anciennes?
Comment soumettre un bon rapport de bogue?
Vous ne devez jamais signaler les problèmes, les vulnérabilités ou les bogues liés à la sécurité, y compris des informations sensibles au tracker de problèmes, ou ailleurs en public. Au lieu de cela, les bogues sensibles doivent être envoyés par e-mail à <>.
Nous utilisons des problèmes GitHub pour suivre les bogues et les erreurs. Si vous rencontrez un problème avec le projet:
- Ouvrez un problème. (Comme nous ne pouvons pas être sûrs à ce stade si c'est un bug ou non, nous vous demandons de ne pas encore parler d'un bogue et de ne pas étiqueter le problème.)
- Expliquez le comportement que vous attendez et le comportement réel.
- Veuillez fournir autant de contexte que possible et décrire les étapes de reproduction que quelqu'un d'autre peut suivre pour recréer le problème par lui-même. Cela comprend généralement votre code. Pour de bons rapports de bogues, vous devez isoler le problème et créer un cas de test réduit.
- Fournissez les informations que vous avez collectées dans la section précédente.
Une fois qu'il est déposé:
- L'équipe de projet étiquetera le problème en conséquence.
- Un membre de l'équipe essaiera de reproduire le problème avec vos étapes fournies. S'il n'y a pas d'étapes de reproduction ou aucun moyen évident de reproduire le problème, l'équipe vous demandera ces étapes et marquera le problème en tant
needs-repro . Les bogues avec la balise needs-repro ne seront pas traités avant leur reproduction. - Si l'équipe est en mesure de reproduire le problème, il sera marqué
needs-fix , ainsi que d'autres étiquettes (telles que critical ), et le problème sera laissé à la mise en œuvre par quelqu'un.
Suggérant des améliorations
Cette section vous guide en soumettant une suggestion d'amélioration pour contribuer.MD, y compris des fonctionnalités complètement nouvelles et des améliorations mineures aux fonctionnalités existantes . Suivre ces lignes directrices aidera les agents et la communauté à comprendre votre suggestion et à trouver des suggestions connexes.
Avant de soumettre une amélioration
- Assurez-vous que vous utilisez la dernière version.
- Lisez attentivement la documentation et découvrez si la fonctionnalité est déjà couverte, peut-être par une configuration individuelle.
- Effectuez une recherche pour voir si l'amélioration a déjà été suggérée. Si c'est le cas, ajoutez un commentaire au problème existant au lieu d'en ouvrir un nouveau.
- Découvrez si votre idée correspond à la portée et aux objectifs du projet. C'est à vous de plaider en faveur de convaincre les développeurs du projet des mérites de cette fonctionnalité. Gardez à l'esprit que nous voulons des fonctionnalités qui seront utiles à la majorité de nos utilisateurs et pas seulement à un petit sous-ensemble. Si vous ciblez simplement une minorité d'utilisateurs, envisagez d'écrire une bibliothèque complémentaire / plugin.
Comment soumettre une bonne suggestion d'amélioration?
Les suggestions d'amélioration sont suivies en tant que problèmes de github.
- Utilisez un titre clair et descriptif pour le problème pour identifier la suggestion.
- Fournissez une description étape par étape de l'amélioration suggérée dans autant de détails que possible.
- Décrivez le comportement actuel et expliquez le comportement que vous attendiez à la place et pourquoi. À ce stade, vous pouvez également dire quelles alternatives ne fonctionnent pas pour vous.
- Vous voudrez peut-être inclure des captures d'écran et des GIF animés qui vous aident à démontrer les étapes ou à souligner la partie à laquelle la suggestion est liée. Vous pouvez utiliser cet outil pour enregistrer les GIF sur macOS et Windows, ainsi que cet outil ou cet outil sur Linux.
- Expliquez pourquoi cette amélioration serait utile pour la plupart des utilisateurs de contribution. Vous pouvez également souligner les autres projets qui l'ont mieux résolu et qui pourrait servir d'inspiration.
