OpenGenus/cosmos

Add documentation in README.md inside each algorithm.

Open

#331 aberto em 3 de out. de 2017

Ver no GitHub
 (9 comments) (3 reactions) (0 assignees)C++ (3.724 forks)batch import
Hacktoberfestadd code

Métricas do repositório

Stars
 (13.462 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 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?

Guia do colaborador

Direção de pesquisa
Pilha de tecnologia
Domain
Tipo Issue
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Prerequisites
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.