github-samples / github-samples/pets-workshop
1-hour workshop: Add concrete validation scenarios for the filter feature
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 80
- Forks
- 161
- Ø Merge
- 31 Min.
- Gemergte PRs (30 T.)
- 1
Beschreibung
Problem
Step 4 tells learners to review the generated code, open the site, run the existing Python tests, and confirm that the functionality works. The current unit tests cover the original dog-list response but do not prove generated breed or availability filtering. The workshop does not give learners concrete expected cases, so an implementation can appear complete while filters are ignored, combined incorrectly, or break pagination.
Because generated solutions vary, behavior-based validation is especially important here.
Suggested change
Add a short manual acceptance checklist and API examples to content/1-hour/4-add-feature.md. Keep it implementation-agnostic.
Acceptance criteria
- Learners verify breed-only filtering.
- Learners verify available-only filtering.
- Learners verify both filters together.
- Changing a control automatically refreshes results as required.
- Clearing filters restores the unfiltered list.
- No-result behavior and pagination/filter interaction are checked.
- The documented Python test command continues to pass.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Öffne content/1-hour/4-add-feature.md und überprüfe Step 4 sowie den bestehenden Python-Testbefehl. Füge implementationsunabhängige manuelle Prüfungen und API-Beispiele für jede Filterkombination, das Aktualisieren, das Löschen von Filtern, keine Ergebnisse und die Paginierung hinzu. Erledigt bedeutet, dass alle Akzeptanzfälle dokumentiert sind und die bestehenden Python-Tests weiterhin erfolgreich sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation, testing-qa
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Aktiv
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 92/100