|
3 | 3 | A repository for team interaction, syncing, and handling meeting notes across the JupyterLab ecosystem. |
4 | 4 |
|
5 | 5 |
|
6 | | -## Process for adding new projects |
| 6 | +## Contributing extensions to the JupyterLab GitHub organization |
7 | 7 |
|
8 | | -If you have an existing JupyterLab extension, or would like to create one, this is the process |
9 | | -for doing so on the core `jupyterlab` organization: |
| 8 | +JupyterLab is built to foster a rich ecosystem of plugins. Occasionally developers of an existing JupyterLab extension will want to contribute the extension to Project Jupyter and maintain the extension in the JupyterLab GitHub organization under [Project Jupyter governance](https://github.com/jupyter/governance), which includes: |
10 | 9 |
|
11 | | -1. You post an issue on this repo describing your extension and linking to any existing code. You should describe who will maintain it and why it will be useful to the community. |
12 | | -2. A core maintainer reviews any existing code as a sanity check. |
13 | | -3. Relicense any existing code to https://github.com/jupyterlab/team-compass/blob/master/LICENSE. |
14 | | -4. Give the community roughly a week to comment on the proposal. |
15 | | -5. Pending any objections, create a new repository. |
16 | | - 1. Give any maintainers admin privileges on that repo |
17 | | - 2. Add them as maintainers on the relevant NPM packages. A user must be added to a team, which then has access to packages (under "Teams"). |
| 10 | +* adopting the standard Jupyter license and copyright |
| 11 | +* adhering to Project Jupyter community guidelines |
| 12 | +* being subject to the Project Jupyter BDFL, Steering Council, and governance. |
| 13 | + |
| 14 | +Project Jupyter has [official guidelines](https://github.com/jupyter/governance/blob/master/newsubprojects.md) for adopting new subprojects. More specifically for contributing extension codebases to the JupyterLab GitHub organization, the process for contributing is: |
| 15 | + |
| 16 | +1. Post an issue on this repo describing your extension and linking to the existing code. The issue should address each point of the [criteria for subprojects](https://github.com/jupyter/governance/blob/master/newsubprojects.md#criteria-for-official-subprojects). |
| 17 | +2. The community reviews the proposal over at least a week. In addition to the criteria listed in the Project Jupyter governance: |
| 18 | + 1. a core maintainer will review the existing code |
| 19 | + 2. we will also take into account how involved the extension maintainers are in the JupyterLab community |
| 20 | +3. If the JupyterLab maintainers decide to accept the extension into the JupyterLab GitHub organization, the process in the Project Jupyter [incorporation guidelines](https://github.com/jupyter/governance/blob/master/newsubprojects.md#incorporation) is followed. Additionally: |
| 21 | + 1. JupyterLab maintainers and other relevant Jupyter leadership (such as BDFL) are given permission to publish the package. |
| 22 | + 2. Extension maintainers are given admin permission on the relevant `@jupyterlab/extension` npm package. To do this, a user must be added to a team, which then has access to packages (under "Teams"): |
18 | 23 | 1. Admin logs in to https://www.npmjs.com |
19 | 24 | 2. Select avatar dropdown and go to "Profile Settings" |
20 | 25 | 3. Select the jupyterlab org |
|
0 commit comments