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.