Melhorar o README

Aberta
#38 3 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
25/100
Tipo de issue
Documentação
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
documentation, localization

Direção de pesquisa

Comece revisando o README atual do repositório, que atualmente contém apenas o CLA e o badge de CI. Esclareça o escopo desejado com os maintainers e, em seguida, documente como compilar a documentação traduzida e adicione um link para o grupo do Telegram, se isso for acordado; o README deve fornecer orientações úteis para os usuários atuais e novos.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

enhancement help wanted

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?

Linguagem predominante
Python
Estrelas
164
Forks
42
Merge médio
14h 32min
PRs com merge (30d)
4

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de python/python-docs-pt-br

Todas as issues de python/python-docs-pt-br

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.