line / line/centraldogma-python
Add simple examples to README.md
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 21
- Forks
- 11
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
README.md could be a gentle guide for users to start centraldogma-python for the first time.
Examples:
https://github.com/line/centraldogma-go
https://github.com/line/centraldogma-rs
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par README.md et comparez le contenu de prise en main des dépôts liés centraldogma-go et centraldogma-rs. Ajoutez des exemples simples de première utilisation pour le client Python, avec suffisamment de contexte pour qu’un nouvel utilisateur puisse les suivre ; le README doit guider clairement l’utilisateur lors du premier parcours d’installation et d’utilisation.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100