pypa / pypa/packaging.python.org
Write prerequisites section for new packaging tutorials
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 1.7k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 4
Description
(For more information about this issue, please see #194).
We need a short section to follow the tutorial introduction (see #195) that makes sure the user has a working Python environment. This should line up with what's in Install pip, setuptools, and wheel, but using a more step-by-step approach (rather than the more self-directed approach of the other section). Additionally, it would be nice to have a step (or steps) that help readers verify that the tools are working.
When opening pull requests for this issue, please submit to the develop branch. If you have questions that concern contributing more generally, please use issue #194. Otherwise, feel free to comment with questions or feedback. Thanks!
Contributor guide
No contributing guide indexed for this repository
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
Review the tutorial introduction referenced in #195, the broader contribution guidance in #194, and the linked “Install pip, setuptools, and wheel” material. Add a short, step-by-step prerequisites section for a working Python environment, including verification steps, and submit the pull request to the develop branch.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100