Melhorar o README

Ouverte
#38 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
25/100
Type d'issue
Documentation
Clarté
À clarifier
Activité
À l'abandon
Stack technique
python

Piste de recherche

Commencez par examiner le README actuel du dépôt, qui ne contient pour le moment que le CLA et le badge CI. Clarifiez le périmètre souhaité avec les maintainers, puis documentez la manière de compiler la documentation traduite et ajoutez un lien vers le groupe Telegram si cela est convenu ; le README doit fournir des indications utiles aux utilisateurs actuels comme aux nouveaux utilisateurs.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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?

Langage dominant
Python
Étoiles
164
Forks
42
Merge moyen
14 h 32 min
PR mergées (30 j)
4

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de python/python-docs-pt-br

Toutes les issues de python/python-docs-pt-br

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.