This repository has been archived by the owner on Sep 3, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from ellisonbg/initial
Directions and proposal template
- Loading branch information
Showing
2 changed files
with
96 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,55 @@ | ||
# proposals | ||
Proposals for new Jupyter subprojects to enter into incubation | ||
# Proposals For Incubation on [jupyter-incubator](https://github.com/jupyter-incubator) | ||
|
||
|
||
## Overview | ||
|
||
Project Jupyter is organized as a set of Subprojects that are each a GitHub | ||
repository with a development team that follows the Jupyter governance, license and | ||
contribution model. Officially supported and maintained subprojects are hosted on | ||
the [jupyter](https://github.com/jupyter) GitHub orgnization. | ||
|
||
Incubation refers to the process of a Subproject initially being developed outside | ||
the official Jupypter organization. The | ||
[jupyter-incubator](https://github.com/jupyter-incubator) GitHub organization is | ||
maintained and managed by Project Jupyter as one possible location where Subproject | ||
can be incubated. The [New Subproject | ||
Process](https://github.com/jupyter/governance/blob/master/newsubprojects.md) | ||
document in the Jupyter [governance](https://github.com/jupyter/governance) | ||
repository details the process of incubation, the process of incorporation into the | ||
main Jupyter organization and the criteria for incorporation. | ||
|
||
|
||
## Incubation process | ||
|
||
This repository is used for incubation proposals. To initiate this process: | ||
|
||
1. Read the [New Subproject Process](https://github.com/jupyter/governance/blob/master/newsubprojects.md) | ||
to see if incubation on [jupyter-incubator](https://github.com/jupyter-incubator) is appropriate for your new Subproject (it might not be). If is doubt, please send an email to the main Jupyter list asking for input. | ||
3. Pick a name for your new Subproject that is free of trademark problems, follows the | ||
naming patterns and conventions used in the project and respects the work of others | ||
even when there are no explicit trademark problems. In general the project favors | ||
functional names that indicate what the Subproject actually does. | ||
4. Find an Advocate for your Subproject who is an active Steering Council member. | ||
5. Create a pull request on this repository by copying the `template` directory | ||
into a new directory with the name of your proposed subprojet. | ||
6. In that pull request fill out the `proposal.md` document in that subdirectory. | ||
7. Announce your proposal for incubation to the community for the main Jupyter list. | ||
|
||
|
||
## Incorporation process | ||
|
||
Incorporation refers to the process of an incubating Subproject becoming an officially | ||
maintained and developed part of Project Jupyter. The incorporation process is described | ||
in the [New Subproject | ||
Process](https://github.com/jupyter/governance/blob/master/newsubprojects.md) document. | ||
|
||
|
||
## Currently incubating Subprojects | ||
|
||
Put links to the [jupyter-incubator](https://github.com/jupyter-incubator) GitHub repositories of all incubating subprojects here. | ||
|
||
* Your next great idea here! | ||
|
||
## Subprojects that have been incorporated into Project Jupyter | ||
|
||
Put links to the [jupyter](https://github.com/jupyter) GitHub repositories of all Subprojects that previously incubated here, but have been incorporated into the main Jupyter organization |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Proposal for Incubation | ||
|
||
Please read the [New Subproject | ||
Process](https://github.com/jupyter/governance/blob/master/newsubprojects.md) for details | ||
about the incubation process. | ||
|
||
Please answer the following question concisely and completely. This proposal doesn't have | ||
to be very long. | ||
|
||
## Subproject name | ||
|
||
What is the name of the proposed Subproject? | ||
|
||
## Development team and Advocate | ||
|
||
Please list the full names, affiliations and GitHub ids of the Subproject development | ||
team: | ||
|
||
* Lisa Simpson, Springfield Elementary School (`@lisasimpson`) | ||
* Bart Simpson, Springfield Elementary School (`@bartsimpson`) | ||
|
||
Who is the Steering Council Advocate for this Subproject? | ||
|
||
* Steering Council Person (`@their-github`) | ||
|
||
## Subproject goals, scope and functionality | ||
|
||
Please describe/list the goals, scope and functionality of this Subproject. | ||
|
||
## Audience | ||
|
||
Please describe who would use the Subproject and what they would use it for. | ||
|
||
## Other options | ||
|
||
Please describe other software, both commercial and open-source that addresses the same goals and audience. | ||
|
||
## Integration with Project Jupyter | ||
|
||
Please describe how this Subproject will integrate with other official Project Jupyter subprojects and efforts. | ||
|