Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Melhorar o README #38

Open
rffontenelle opened this issue Oct 2, 2020 · 3 comments
Open

Melhorar o README #38

rffontenelle opened this issue Oct 2, 2020 · 3 comments

Comments

@rffontenelle
Copy link
Collaborator

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?

@glauesppen
Copy link

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

@bitterteriyaki
Copy link

Também é possível inserir um guia simples de como contribuir com o projeto. Posso fazer PR disso hoje, se precisar.

@rffontenelle
Copy link
Collaborator Author

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants