Hojgaetan/LMS

Créer un guide de contribution détaillé

Open

#7 opened on Sep 30, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (2 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Contributor guide

Research direction
Review successful open source contribution guides for Python projects and adapt the structure to this repository. Focus on clear examples and step by step instructions.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85