OpenGenus/cosmos

Add documentation in README.md inside each algorithm.

Open

#331 opened on 2017年10月3日

GitHub で見る
 (9 comments) (3 reactions) (0 assignees)C++ (3,724 forks)batch import
Hacktoberfestadd code

Repository metrics

Stars
 (13,462 stars)
PR merge metrics
 (30d に merged PR はありません)

説明

So I noticed there's a README.md file inside each folder that actually provides no useful information.

What about we change each README.md file, for example cosmos/code/search/ternary_search/README.md to explain a bit about the Ternary Search algorithm?

コントリビューターガイド

調査方針
技術スタック
領域
Issue 種別
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
前提条件
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。