raselmeya94/RAGpedia

Improve Documentation in CONTRIBUTING.md for Clarity

Open

#4 ouverte le 12 nov. 2024

Voir sur GitHub
 (2 commentaires) (0 réactions) (1 assigné)Python (1 fork)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (3 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

Our CONTRIBUTING.md could use some improvements to make it more contributor-friendly! Suggested improvements include:

  • Clarifying Contribution Steps: Ensure each step is easy to follow.
  • Adding Examples: Provide examples of how to format entries or code snippets.
  • Adding FAQ Section: Common questions and answers for new contributors.

If you have ideas, please fork the repository and submit a PR with your suggested changes. This will help future contributors engage more easily with RAGpedia. Thank you!

Guide contributeur

Direction de recherche
Lisez le CONTRIBUTING.md actuel et identifiez les zones à améliorer. Forkez le depot, apportez des modifications et soumettez une PR.
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.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85