OpenGenus/cosmos

Explanation file of implemented code

Open

#4,957 opened on 2020年3月30日

GitHub で見る
 (8 comments) (0 reactions) (1 assignee)C++ (13,462 stars) (3,724 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.