pyvec / pyvec/python.cz

Lepší README

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

Personne n'a encore pris cette issue.

technical
Langage dominant
Python
Étoiles
46
Forks
115
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

Hlavně aby dokumentovalo, jak rozběhat projekt a co je účelem webovky (a co účelem té webovky - už - není). Viz https://github.com/pyvec/python.cz/pull/559

Hlavně zmínit, že skoro všechno je prostě zdokumentováno v dokumentaci MkDocs a hlavně mkdocs-material

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.

Piste de recherche

Commencez par README et examinez la pull request référencée #559. Consultez la documentation existante de MkDocs et mkdocs-material afin de résumer comment exécuter le projet, à quoi sert le site web et quelles responsabilités il n’a plus. Le travail sera considéré comme terminé lorsque README orientera les lecteurs vers la documentation pertinente et couvrira clairement la configuration et l’objectif.

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

Évaluation

Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

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