Repository navigation
Conversation
|
Someone is attempting to deploy a commit to the komalsony234-1530's projects Team on Vercel. A member of the Team first needs to authorize it. |
This branch has not been deployed
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
The README's "Verify Everything Works" section tells new users to run
pytest tests/, but the Quick Start only installsrequirements.txt, and pytest is inrequirements-dev.txt. On a fresh setup, the documented test command fails because pytest isn't installed. This PR adds the missing install step and a changelog entry.Related Issue
Closes #1943
Type of Change
What Was Changed
README.mdpip install -r requirements-dev.txtbeforepytest tests/and updated the sentence above itCHANGELOG.mdHow to Test This PR
pip install -r requirements.txtpython -m pytest tests/. Before this change, this fails with "No module named pytest".pip install -r requirements-dev.txt, thenpython -m pytest tests/again. pytest now runs and collects 668 tests.Test Results
Tested on macOS with Python 3.12 in a fresh virtual environment, after installing
requirements-dev.txt:The 28 failures are in
test_bookmarks.py,test_no_results_reset.py,test_og_tags.py,test_pagination.py,test_profile_sections.py,test_progress_calculation.pyandtest_share_project.py(missing OG/Twitter meta tags, progress-bar ARIA attributes, saved-projects panel, share toast, profile sections, and no project cards on/explore). This PR only changes docs and does not touch them.Self-Review Checklist
feat/,fix/,docs/,data/,style/,test/pytest tests/and all test suites passflake8 .locally and there are no errorsprint()orconsole.log()debug statementsNotes for Reviewer
pytest tests/does not fully pass on my clean setup (28 failures, listed above), and I didn't runflake8 .because no Python files changed. The last two items don't apply to a docs-only change.python tests/test_basic.py(Contributing section) and "27 tests" (Project Structure). I can update those in this PR or a follow-up, whichever you prefer.