python-docs-pt-br
python-docs-pt-br copied to clipboard
python
Melhorar o README
Atualmente o README deste repositório contém apenas o CLA e badge de CI.
Penso que seria interessante termos mais informações nele que sejam úteis tanto para usuários atuais quanto novatos/passageiros. Por exemplo, poderíamos ter instruções sobre como compilar a documentação traduzida ou um link para o grupo do Telegram para quem quiser possa nos contatar.
Ideias, sugestões?
Minha sugestão seria:
- Versão que temos hoje da doc
- As badges de doc do proprio github (doc passing..)
- Ultimos Commits
- Redes sociais (se aplicável) Tive essas ideias olhando aqui: https://github.com/Naereen/badges
Também é possível inserir um guia simples de como contribuir com o projeto. Posso fazer PR disso hoje, se precisar.
@bitterteriyaki Pode ser uma boa ideia. Eu estava falando num dia desses em nosso grupo Telegram que apesar de termos um guia de tradução hospedado em https://github.com/python/python-docs-pt-br/wiki, sinto que essa informação está muito escondida. Talvez alguma informação, ainda que reduzida, no README, pode ser útil para quem começar.
Outra frente de "ataque" é ajustar as informações em https://python.org.br/traducao/. Talvez lá seja um local mais acessado (via Google, por exemplo) do que este repositório.