OpenGenus/cosmos

Explanation file of implemented code

Open

#4.957 aberto em 30 de mar. de 2020

Ver no GitHub
 (8 comments) (0 reactions) (1 assignee)C++ (3.724 forks)batch import
enhancementgood first issue

Métricas do repositório

Stars
 (13.462 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

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.

Guia do colaborador

Direção de pesquisa
Escolha um algoritmo do repositório, estude seu código e crie um arquivo README.md explicando o algoritmo com texto e diagramas. Inclua exemplos e análise de complexidade.
Pilha de tecnologia
None
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80