CSSG-Labs/flask-todo-app

Improve CONTRIBUTING.md documentation

Aperta

#32 aperta il 11 mag 2022

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (1 assegnatario)HTML (4 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (2 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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)

Guida contributor

Direzione di ricerca
Leggi l'attuale CONTRIBUTING.md, poi fai riferimento alla guida all'installazione di Flask per Linux e macOS e documenta i passaggi con screenshot e un video.
Tech stack
pythonflask
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85