OpenGenus/cosmos

Explanation file of implemented code

Open

#4,957 opened on Mar 30, 2020

View on GitHub
 (8 comments) (0 reactions) (1 assignee)C++ (13,462 stars) (3,724 forks)batch import
enhancementgood first issue

Description

This is a(n):

  • New algorithm
  • Update to an existing algorithm
  • Error
  • Proposal to the Repository

Details:

We can make a file may be READ.md file in every algorithm. reading code without explanation is difficult for learners so I am proposing an explanation of implemented programs using gifs, text, or any pictorial method. Reading merely code doesn't help much but explanation does help. I would like to work on it.

Contributor guide

Tech stack
cpp
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.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of algorithmsMarkdown syntaxGit and GitHub basicsUnderstanding repository structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue proposes adding README files with explanations (text, gifs, or pictorial) to each algorithm directory. Currently, the repository has algorithm implementations without such explanations. The assignee appears to be working on this, so the issue is blocked. To start, a contributor could examine an existing algorithm implementation (e.g., in the algorithms directory) and create a README explaining the code, its logic, and how to use it. The repository structure and conventions should be followed.