pyupio/safety

Documentation Improvements

Open

#572 aberto em 14 de ago. de 2024

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Python (135 forks)batch import
good first issue

Métricas do repositório

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

Description

This issue is intended to encourage continuous improvement of the documentation across the repository. We are looking for contributions that enhance clarity, add examples, or update existing documentation to better reflect current functionality. If you notice an area of the documentation that could benefit from an update or expansion, please feel free to contribute! After making your changes, create a new issue describing what you’ve done and link it to this general documentation improvement issue.

Guia do colaborador

Direção de pesquisa
Comece revisando o README do projeto, o guia de contribuição e qualquer outra documentação no repositório. Identifique áreas que carecem de clareza, estão sem exemplos ou contêm informações desatualizadas. Você também pode verificar o rastreador de problemas do repositório para solicitações específicas de documentação. Após fazer melhorias, crie um novo problema descrevendo suas alterações e vincule o a este problema. Mantenha o estilo e o tom da documentação do projeto.
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.
Recente
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.
85