Repository navigation
Polish the README for the JSONPlaceholder contract suite - #2
Merged
Merged
Conversation
Describe the posts, comments, and users checks, paste the 12 November 2026 pytest log, and point setup at the Ubuntu venv package the documented command needs. Co-authored-by: David Kupratis <dkupratis@student.bccc.edu>
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites
README.mdfor a support, QA, tooling, and automation portfolio read. The page now leads with what the suite is for, then the posts, comments, and users behaviors the tests lock in, a real pytest log, setup, how to run, the stack, the CI badge, the layout, and the MIT line.The test log is from this checkout on 12 November 2026 (Python 3.12.3).
python -m ruff check .printedAll checks passed!.python -m pytestfinished with 28 passed and 24 skipped.python -m pytest --livecalledhttps://jsonplaceholder.typicode.comand finished with 52 passed in 1.89s. The mocked block in the README is an excerpt: the 21SKIPPEDlines are described in the prose and left out of the fence. The live block is the full log.Setup now mentions
python3.12-venv. On this Ubuntu machine,python3 -m venv .venvstopped withensurepip is not availableuntil that package was installed. The rest of the documented Linux commands then ran.The local Python 3.11 result is gone. This log is 3.12.3. The workflow still runs the mocked suite on 3.11 and 3.12, and the live job still runs only on a manual dispatch.
The CI badge points at
.github/workflows/ci.yml.LICENSEwas already MIT for David Kupratis, so the README only links that line.Test plan
python3 -m venv .venvafterpython3.12-venvwas installedpython -m pip install -e ".[dev]"python -m ruff check .python -m pytest(28 passed, 24 skipped)python -m pytest --live(52 passed)API_TEST_LIVE=1 python -m pytest(52 passed)API_TEST_LIVE=1 python -m pytest -m liveandpython -m pytest --live -m live(24 passed, 28 deselected)python -m pytest -m "not live"(28 passed, 24 deselected)