Problem Statement
As a JupyterHub contributor, it is unclear how and where to contribute because contribution documentation is spread out across package documentation, CONTRIBUTING.md files, and team compass documentation. This is an impediment to getting started contributing to JupyterHub because I spend too much time looking for information and the answers are not clear.
Proposed Solution
Improve consistency and discoverability of contributor documentation to address:
- finding work to contribute
- setting up for contributions of various sorts
- best practices for pull requests, issues, tests, etc.
Proposed Implementation
Some of the complexity is real, but not all. Contributing to different repos requires extremely different setups and skills. However, some standardization and We should audit contributing documentation for at least a few key repositories and the team compass to ensure that relevant information is discoverable, complete, not overly duplicated, and welcoming. In particular, complete an audit of CONTRIBUTING.md jupyterhub/team-compass#852 across repos. The content doesn't need to be identical, but they should all be consistent, and consolidate some generic / common information in the team compass contributing docs.
What I explicitly don't propose is standardization of tools such as hatch/pixi/nox, etc. which add more indirection and abstraction than I think is helpful.
How will this fit in the ecosystem?
By following good practices of supporting contributions with clear and consistent documentation, we provide a good interface for connecting with contributors across the JupyterHub-related ecosystem.
Endorsements
Problem Statement
As a JupyterHub contributor, it is unclear how and where to contribute because contribution documentation is spread out across package documentation, CONTRIBUTING.md files, and team compass documentation. This is an impediment to getting started contributing to JupyterHub because I spend too much time looking for information and the answers are not clear.
Proposed Solution
Improve consistency and discoverability of contributor documentation to address:
Proposed Implementation
Some of the complexity is real, but not all. Contributing to different repos requires extremely different setups and skills. However, some standardization and We should audit contributing documentation for at least a few key repositories and the team compass to ensure that relevant information is discoverable, complete, not overly duplicated, and welcoming. In particular, complete an audit of CONTRIBUTING.md jupyterhub/team-compass#852 across repos. The content doesn't need to be identical, but they should all be consistent, and consolidate some generic / common information in the team compass contributing docs.
What I explicitly don't propose is standardization of tools such as hatch/pixi/nox, etc. which add more indirection and abstraction than I think is helpful.
How will this fit in the ecosystem?
By following good practices of supporting contributions with clear and consistent documentation, we provide a good interface for connecting with contributors across the JupyterHub-related ecosystem.
Endorsements
CONTRIBUTING.mdand their instructions across the various JupyterHub repositories. team-compass#852