[mkdocs] Improve descriptions
Aberta
Ninguém assumiu esta issue ainda.
documentation
P2
- Linguagem predominante
- Python
- Estrelas
- 18.8k
- Forks
- 2.8k
- Merge médio
- 16h 26min
- PRs com merge (30d)
- 21
Descrição
Looking at https://github.com/daexs/plotly.py/pull/80/files, some of the descriptions are very short and not informative.
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece revisando as alterações nos arquivos e nas descrições mostradas no pull request referenciado. Identifique as descrições que são muito curtas ou pouco informativas e, em seguida, atualize-as para que a documentação afetada fique mais clara; considera-se concluído quando as descrições relevantes fornecem um contexto útil sem brevidade desnecessária.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 35/100