OpenGenus/cosmos

Explanation file of implemented code

Open

#4,957 创建于 2020年3月30日

在 GitHub 查看
 (8 评论) (0 反应) (1 负责人)C++ (13,462 star) (3,724 fork)batch import
enhancementgood first issue

描述

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.

贡献者指南

技术栈
cpp
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
blocked
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Basic knowledge of algorithmsMarkdown syntaxGit and GitHub basicsUnderstanding repository structure
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
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.