raselmeya94/RAGpedia

Improve Documentation in CONTRIBUTING.md for Clarity

Open

#4 opened on Nov 12, 2024

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Python (1 fork)auto 404
documentationgood first issue

Repository metrics

Stars
 (3 stars)
PR merge metrics
 (PR metrics pending)

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!

Contributor guide

Research direction
Read the current CONTRIBUTING.md and identify areas for improvement. Fork the repo, make changes, and submit a PR.
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85