Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Outreachy Project Proposal]: JupyterHub Python projects common practices #197

Open
GeorgianaElena opened this issue Jun 19, 2023 · 0 comments
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

Comments

@GeorgianaElena
Copy link
Member

Summary of Project

Update the repository at https:/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:/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:

  • Bring JupyterHub projects up to date through the help of the community.
    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.
  • Create new projects fast, because we can use the repository as a template

Will you mentor this project yourself?

No, this project is available for others to mentor.

Link to scoping document for the proposal

TBD

@GeorgianaElena GeorgianaElena added needs: mentor A project proposal that is looking for someone to mentor is status: scoping A project proposal that is still in the process of being written up project-proposal A project proposal to be submitted to an Outreachy round labels Jun 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

1 participant