CSSG-Labs/flask-todo-app

Improve CONTRIBUTING.md documentation

Offen

#32 geöffnet am 11.05.2022

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)HTML (4 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (2 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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)

Contributor Guide

Research-Richtung
Lesen Sie die aktuelle CONTRIBUTING.md, schlagen Sie dann in der Flask Installationsanleitung für Linux und macOS nach und dokumentieren Sie die Schritte mit Screenshots und einem Video.
Tech Stack
pythonflask
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85