pytest-dev / pytest-dev/pytest-django
Add information about how to setup Python path in the "Getting started" guide
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 367
- PR merge metrics
- No merged PRs in 30d
Description
Refs #23
Currently, only the FAQ shows how to setup the Python path in order for pytest to find the project properly. This information should be more prominent in the tutorial which is the first thing someone switching to pytest-django reads.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the existing Python path setup guidance in the FAQ, then locate the Getting started guide referenced in the issue. Confirm how pytest-django expects the path to be configured and make the same guidance prominent in the tutorial. Done means a new reader can find the setup instructions in Getting started without consulting the FAQ.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- django, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100