OpenGenus/cosmos

Add documentation in README.md inside each algorithm.

Open

#331 opened on Oct 3, 2017

View on GitHubContributor guide
 (9 comments) (3 reactions) (0 assignees)C++ (3,724 forks)batch import
Hacktoberfestadd code

Repository metrics

Stars
 (13,462 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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?

Contributor guide

Research direction
Examine an existing README.md file in the repository to understand the format, then write a clear explanation of the algorithm for each folder's README.
Tech stack
cpp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85