CSSG-Labs/flask-todo-app

Improve CONTRIBUTING.md documentation

Ouverte

#32 ouverte le 11 mai 2022

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (1 personne assignée)HTML (4 forks)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (2 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

What

  • Adds linux and macOS instructions in CONTRIBUTING.md's "Development Environment Setup" section
  • Adds video and screenshots to make the process easier to understand

Why

  • Current document does not provide instructions for linux or macOs
  • Also does not provide enough explanation in the steps
  • Lack of detailed instructions hurts the onboarding process for new members

How

Requirements

  • Improved steps should be clear and descriptive
  • There should be visual elements (screenshots or video)

Guide contributeur

Direction de recherche
Lisez le CONTRIBUTING.md actuel, reportez vous au guide d'installation de Flask pour Linux et macOS et documentez les étapes avec des captures d'écran et une vidéo.
Stack technique
pythonflask
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85