OpenGenus/cosmos

Add documentation in README.md inside each algorithm.

Open

#331 建立於 2017年10月3日

在 GitHub 查看
 (9 留言) (3 反應) (0 負責人)C++ (3,724 fork)batch import
Hacktoberfestadd code

倉庫指標

Star
 (13,462 star)
PR 合併指標
 (30 天內沒有已合併 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?

貢獻者指南

研究方向
技術棧
領域
議題類型
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
前置要求
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。