Hojgaetan/LMS

Créer un guide de contribution détaillé

Ouverte

#7 ouverte le 30 sept. 2025

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Python (2 forks)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (2 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Difficulté: 🟢 Facile Temps estimé: 2-3 heures

Description: Améliorer le fichier CONTRIBUTING.md avec des exemples concrets et des workflows détaillés.

Tâches:

  • Ajouter des exemples de messages de commit suivant les conventions
  • Créer un guide étape par étape pour le premier pull request
  • Ajouter une section sur l'environnement de développement
  • Inclure des exemples de structure de branches (feature/, bugfix/, etc.)
  • Ajouter des liens vers les ressources utiles (Python PEP8, Git workflows)

Fichiers à modifier:

  • CONTRIBUTING.md

Critères d'acceptation:

  • Le guide est clair et facile à suivre
  • Inclut des exemples pratiques
  • Cohérent avec les bonnes pratiques de développement

Guide contributeur

Direction de recherche
Examinez les guides de contribution open source réussis pour les projets Python et adaptez la structure à ce dépôt. Concentrez vous sur des exemples clairs et des instructions étape par étape.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85