[Outreachy Project Proposal]: JupyterHub Python projects common practices #197
Labels
needs: mentor
A project proposal that is looking for someone to mentor is
project-proposal
A project proposal to be submitted to an Outreachy round
status: scoping
A project proposal that is still in the process of being written up
Summary of Project
Update the repository at https://github.com/jupyterhub/jupyterhub-python-repo-template to match current practices in the JupyterHub organization. All the practices in this repository must be documented.
Advertise these docs as the source of truth and link them from subprojects, including https://github.com/jupyterhub/team-compass. The
team-compass
repository is the repository which currently holds some information about project practices under the section at https://jupyterhub-team-compass.readthedocs.io/en/latest/index-team_guides.html, but it is quite general and not rigorously kept up to date.Possible strech goal
Track down the subprojects that don't follow latest practices and update them where possible.
Value to the intern
I believe this can be a great project to learn about open source practices, Python projects practices and JupyterHub in general.
Motivation
Having a source of truth for the practices that we follow as an organization for the Python projects that we maintain, will help to:
We can ask the community to help us maintain the repositories up to date with what's considered standard at a moment in time. Having a souruce of truth will make it more clear what needs to be updated and why.
Will you mentor this project yourself?
No, this project is available for others to mentor.
Link to scoping document for the proposal
TBD
The text was updated successfully, but these errors were encountered: