Enhancement: Add proper documentation

Métricas do repositório

Stars

1.405 estrelas (1.405 estrelas)

Métricas de merge de PR

Mesclagem média 2d 4h (Mesclagem média 2d 4h)66 fundiu PRs em 30d (66 fundiu PRs em 30d)

Description

Guia do colaborador

Direção de pesquisa

Examine a estrutura de documentação existente na referência vinculada e proponha uma estrutura semelhante para este repositório.

Pilha de tecnologia

python

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.

1

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

GitMarkdown

Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.

90