0 Fork 0

mirror of https://github.com/Gathin23/cleanyourtv.git synced 2026-11-05 21:06:40 +00:00

Files

T

xbsheng 8fc54b1ad3 docs: the showcase recipe asks for both count lines

docs/workflows/showcase.md is where AGENTS.md's workflow list and CONTRIBUTING's routing
table send a new showcase author, and its numbered steps are the checklist they follow. Step 1
asked for the row, its section and its brand index entry and stopped there, while
tests/test_showcase_project_count.py counts the rows on every run and fails a page whose
'N projects so far.' line and README's spelled number were left behind - reproduced on cc4c7c59
by adding one row the way that step reads:

    AssertionError: SHOWCASE.md says 81 projects and its tables hold 82 rows: bump the number
    (and README.md's spelled one) when you add a project

Step 2 now asks for both numbers; steps 3-5 are the old 2-4 apart from their numbers.
tests/test_showcase_recipe_count.py (9 tests; 1 failure + 2 errors on cc4c7c59) reads the
recipe's numbered steps and copies nothing in: the phrase the count line must carry comes from
the check's own stated_number(), and three tests run that check over pages written in the test
(a page one row short is refused and named, an agreeing page is quiet, README's spelled number
is read) so a checker that stops counting fails this pair. No row, brand index, SHOWCASE.md,
launcher, list, tool or safety path touched: one recipe page + one test file.

2026-10-24 14:24:31 +08:00

1013 B

Raw Blame History

Workflow: Add a showcase row

When to use this: a project built on this repo that lives in its own repository.

Add one row to the section of SHOWCASE.md that fits (home screens, forks, screensavers and add-ons, tools, other platforms), and the project under its TV brand in "Find a project by TV brand".
Bump the two counts by one: SHOWCASE.md opens with an N projects so far. line, and the "Built something on top?" row in README.md spells the same number in words. tests/test_showcase_project_count.py refuses a row that leaves either of them behind.
Keep each cell to one line: what it is, what it was built and tested on, and the author.
The project is open source with a link people can read and build, says which TV it was tested on, collects nothing beyond what its README says, and is yours or listed with the author's blessing.
Put a screenshot in the PR description; it is linked from the row.

Then run the tests: python3 -m unittest discover -s tests -v.

1013 B Raw Blame History

Workflow: Add a showcase row

1013 B

Raw Blame History