school-brainhack / school-brainhack/school-brainhack.github.io
Maintenance of [packaging] module
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 42
- Forks
- 185
- PR merge metrics
- No merged PRs in 30d
Description
Module to maintain
Website: https://school.brainhackmtl.org/modules/packaging/
Code: https://github.com/school-brainhack/school-brainhack.github.io/tree/main/content/en/modules/packaging
Work to be done
The Python packaging ecosystem has significantly evolved since this module content was originally developed. To ease maintenance burden and to better reflect current state-of-the-art, I would propose that the material should focus on the official Python packaging tutorial : https://packaging.python.org/en/latest/tutorials/packaging-projects/
I would also suggest that this tutorial could have more direct links with the testing module, as both the official tutorial and other, updated resources include testing in their initial package definition.
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 module content in content/en/modules/packaging and compare it with the official Python packaging tutorial linked in the issue. Check the existing testing module and the referenced packaging notes for relevant connections. Done means the packaging material reflects current guidance and links clearly to testing resources.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100