1-hour workshop: Add concrete validation scenarios for the filter feature

Open Beginner friendly
#261 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
92/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation, testing-qa

Research direction

Open content/1-hour/4-add-feature.md and review Step 4 and its existing Python test command. Add implementation-agnostic manual checks and API examples for each filter combination, refresh behavior, clearing filters, no results, and pagination. Done means all acceptance cases are documented and the existing Python tests still pass.

Written by the indexing model from the issue text.

Description

priority: P1

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.
Dominant language
Python
Stars
80
Forks
161
Avg merge
31m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github-samples/pets-workshop

All issues in github-samples/pets-workshop

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.