falconry/falcon

Consider moving all the tutorial code to files, having not only the final version there

Offen

#2.247 geöffnet am 13.07.2024

Auf GitHub ansehenContributor Guide
 (8 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (925 Forks)batch import
documentationgood first issuemaintenance

Repository-Metriken

Stars
 (9.293 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 2T 7h) (9 gemergte PRs in 30 T)

Beschreibung

At the moment only the final version of the tutorials is in the example folder, while the intermediate code is pasted into the rst files.

It would be nice to have all versions in code, so that lint and format tool etc could work on those too.

We could probably use examples/asgilook/versions/01_file.py, examples/asgilook/versions/02_file.py etc

Contributor Guide

Research-Richtung
Untersuche den aktuellen Ordner 'examples/asgilook/' und die RST Tutorialdateien. Schlage ein Benennungsschema für versionierte Dateien vor (z. B. '01 file.py', '02 file.py') und verschiebe den Zwischencode aus den RST Dateien in diese neuen Dateien. Aktualisiere die RST Dateien, um den Code aus den neuen Dateien anstelle von Inline Snippets zu enthalten. Stelle sicher, dass Lint und Formatierungswerkzeuge auf alle versionierten Dateien angewendet werden können.
Tech Stack
python
Domain
documentation
Issue Type
Refactoring
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
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80