Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 3.36 KB

jupyter-enhancement-proposal-guidelines.md

File metadata and controls

61 lines (44 loc) · 3.36 KB

Jupyter Enhancement Proposals (JEP) Guidelines

Problem

Enhancements to the Jupyter ecosystem are currently presented across a multitude of platforms without any centralized management or discussion.

Proposed Enhancement

Jupyter Enhancement Proposals will be used when presenting changes or additions that affect multiple components of the Jupyter ecosystem. These changes can include things like:

  • Additions/changes to the message spec
  • API design that is consumed and produced in several contexts (e.g. the notebook kernel API)
  • The notebook format

The format of this README is itself a JEP and can be duplicated for the creation of further JEPs.

Detail Explanation

JEP Titles

Jupyter Enhancement Proposals will be submitted with a title that is no longer than 12-words long. A JEP is uniquely identified by its title and the pull request number associated with it.

JEP Labels

The pull-request submitted with each JEP will be labeled with the following labels for easy searching:

  • accepted — this JEP has been accepted and is currently being implemented
  • implemented — this JEP has been implemented
  • rejected - this JEP has been rejected and will not be implemented
  • withdrawn - this JEP has been withdrawn by the submitter but can be re-submitted if someone is willing to champion it
  • active - this JEP is currently under active discussion within the community

JEP Structure

When submitting an enhancement proposal, individuals will include the following information in their submission.

  1. The problem that this enhancement addresses. If possible include code or anecdotes to describe this problem to readers.
  2. A brief (1-2 sentences) overview of the enhancement you are proposing. If possible include hypothetical code sample to describe how the solution would work to readers.
  3. A detailed explanation covering relevant algorithms, data structures, an API spec, and any other relevant technical information
  4. A list of pros that this implementation has over other potential implementations.
  5. A list of cons that this implementation has.
  6. A list of individuals who would be interested in contributing to this enhancement should it be accepted.

JEP Submission Process

  1. Create a Markdown write up of the problem, proposed enhancement, detailed technical explanation, pros and cons, and interested contributors of the enhancement you are proposing.
  2. Create a fork of this repository.
  3. Create a folder with its name set to the JEP title in lower snake-case.
  4. Place the markdown file created in step 1 and any supplemental materials in that folder.
  5. Submit a pull request to the main repository with your JEP.
  6. Once your PR is accepted, it will be labeled active per the guidelines above.
  7. Your JEP will be added to the JEP Index file in this repository.

Pros and Cons

Pros associated with this implementation include:

  • A higher quality discussion around enhancement proposals
  • Individuals are encourage to put more thought into an enhancement proposal before submitting it
  • Precedence exists in the form of PEPs (Python Enhancement Proposals) and IPEPs (IPython Enhancement Proposals)

Cons associated with this implementation include:

  • Existing IPEPs (IPython Enhancement Proposals) will not be included in this migrated repository

Interested Contributors

@captainsafia, @rgbkrk