-
Notifications
You must be signed in to change notification settings - Fork 19
Add Jumpstarter Enhancement Proposal (JEP) Process and Issue Template #423
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
base: main
Are you sure you want to change the base?
Changes from 3 commits
652b3d2
ba57ff9
6b005cf
db7391e
a30de99
cb16b2f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,217 @@ | ||
| # JEP-0000: Jumpstarter Enhancement Proposal Process | ||
|
|
||
| | Field | Value | | ||
| |------------------|----------------------------------------------------| | ||
| | **JEP** | 0000 | | ||
| | **Title** | Jumpstarter Enhancement Proposal Process | | ||
| | **Author(s)** | Jumpstarter Maintainers | | ||
| | **Status** | Active | | ||
| | **Type** | Process | | ||
| | **Created** | 2026-04-06 | | ||
| | **Discussion** | [Matrix](https://matrix.to/#/#jumpstarter:matrix.org) | | ||
|
|
||
| ## Abstract | ||
|
|
||
| This document defines the Jumpstarter Enhancement Proposal (JEP) process — the | ||
| mechanism by which substantial changes to the Jumpstarter project are proposed, | ||
| discussed, and decided upon. JEPs provide a consistent, transparent record of | ||
| design decisions for the Jumpstarter hardware-in-the-loop (HiL) testing framework | ||
| and its ecosystem of drivers, CLI tools, operator components, and protocol | ||
| definitions. | ||
|
|
||
| ## Motivation | ||
|
|
||
| As Jumpstarter grows in contributors, drivers, and production deployments, the | ||
| project needs a structured way to propose and evaluate changes that go beyond | ||
| routine bug fixes and minor improvements. An informal "open a PR and see what | ||
| happens" approach doesn't scale when changes touch hardware interfaces, gRPC | ||
| protocol definitions, operator CRDs, or the driver plugin architecture — areas | ||
| where mistakes are expensive to reverse. | ||
|
|
||
| The JEP process gives the community: | ||
|
|
||
| - **Visibility** — a single place to discover what's being proposed, what's been | ||
| decided, and why. | ||
| - **Structured discussion** — a template that forces authors to think through | ||
| motivation, hardware implications, backward compatibility, and testing before | ||
| code is written. | ||
| - **Historical record** — versioned markdown files in the repository whose git | ||
| history captures the evolution of each proposal. | ||
| - **Inclusive governance** — a lightweight, PR-based workflow that any contributor | ||
| can participate in, regardless of commit access. | ||
|
|
||
| ## What Requires a JEP | ||
|
|
||
| Not every change needs a JEP. Use the following guidelines: | ||
|
|
||
| **A JEP is required for:** | ||
|
|
||
| - New features or subsystems in the core framework (e.g., a new lease scheduling | ||
| strategy, a new exporter transport mechanism). | ||
| - Changes to the gRPC protocol (`.proto` files) or the operator CRD schema. | ||
| - New driver interface contracts or modifications to existing driver base classes. | ||
| - Changes to the `jmp` CLI that alter user-facing behavior in breaking ways. | ||
| - Introduction of new infrastructure requirements (e.g., requiring a new | ||
| Kubernetes operator dependency, adding a new container runtime assumption). | ||
| - Significant changes to the packaging or distribution model (e.g., modifying the | ||
| `packages/` monorepo structure, changing the private package index behavior). | ||
| - Process or governance changes (like this JEP itself). | ||
|
|
||
| **A JEP is NOT required for:** | ||
|
|
||
| - Bug fixes and minor patches. | ||
| - New drivers that follow the existing driver scaffold and don't modify framework | ||
| interfaces (use the standard driver contribution workflow instead). | ||
| - Documentation improvements. | ||
| - Dependency version bumps (unless they introduce breaking changes). | ||
| - Refactoring that doesn't change public APIs. | ||
| - Test improvements. | ||
|
|
||
| When in doubt, ask in [Matrix](https://matrix.to/#/#jumpstarter:matrix.org) or | ||
| open a GitHub issue to gauge whether your idea warrants a JEP. | ||
|
|
||
| ## JEP Types | ||
|
|
||
| | Type | Description | | ||
| |--------------------|--------------------------------------------------------------------------------------------------------| | ||
| | **Standards Track** | Proposes a new feature or implementation change. Results in new or modified code, protocol definitions, or CRDs. | | ||
| | **Informational** | Provides guidelines, background, or describes an issue without proposing a specific change. Does not require community consensus to adopt. | | ||
| | **Process** | Proposes a change to the Jumpstarter development process, governance, or workflow (like this JEP). | | ||
|
|
||
| ## JEP Lifecycle | ||
|
|
||
| ```mermaid | ||
| flowchart TD | ||
| A([Start]) --> B[Draft] | ||
| B -->|PR opened| C[Proposed] | ||
| C -->|Maintainers approve| D[Accepted] | ||
| C -->|Maintainers decline| E[Rejected] | ||
| D -->|Work begins| F[Implementing] | ||
| F -->|Code merged| G[Implemented] | ||
| G -->|Stabilized| H[Final] | ||
| F -->|Deprioritized| I[Deferred] | ||
| D -->|Deprioritized| I | ||
| I -.->|Revisited| C | ||
| ``` | ||
|
|
||
| > **Note:** A JEP can move to **Withdrawn** from any pre-Final status | ||
| > (at the author's discretion) and to **Superseded** from any status | ||
| > (when replaced by a newer JEP). These transitions are omitted from | ||
| > the diagram for clarity. | ||
|
|
||
| | Status | Meaning | | ||
| |------------------|------------------------------------------------------------------------------------------| | ||
| | **Draft** | Author is still writing the JEP. Not yet open for formal review. | | ||
| | **Proposed** | JEP PR is open and under community discussion. | | ||
| | **Accepted** | Maintainers have approved the design. Implementation may begin. | | ||
| | **Implementing** | Implementation is in progress. The JEP may be updated with implementation learnings. | | ||
| | **Implemented** | Reference implementation is complete and merged. | | ||
| | **Final** | JEP is complete and considered the authoritative record of the feature. | | ||
| | **Rejected** | Maintainers have declined the proposal. The JEP remains as a record of the decision. | | ||
| | **Deferred** | Proposal is sound but not a current priority. May be revisited later. | | ||
| | **Withdrawn** | Author has voluntarily withdrawn the proposal. | | ||
| | **Superseded** | Replaced by a newer JEP. The `Superseded-By` field indicates the replacement. | | ||
|
|
||
| A JEP can move to **Withdrawn** from any pre-Final status. A JEP can move to | ||
| **Superseded** from any status. | ||
|
|
||
| ## JEP Workflow | ||
|
|
||
| ### 1. Socialize the Idea | ||
|
|
||
| Before writing a JEP, discuss the idea informally: | ||
|
|
||
| - Start a thread in [Matrix](https://matrix.to/#/#jumpstarter:matrix.org). | ||
| - Add it to the agenda for the [weekly meeting](https://meet.google.com/gzd-hhbd-hpu). | ||
| - Open a GitHub issue labeled `jep/discussion` for early feedback. | ||
|
|
||
| This step helps determine whether a JEP is warranted, identifies potential | ||
| reviewers, and surfaces obvious concerns early. | ||
|
|
||
| ### 2. Submit a JEP Pull Request | ||
|
|
||
| Create a new branch and add your JEP as a markdown file in the `jeps/` | ||
| directory, following the [JEP template](JEP-NNNN-template.md). Open a pull | ||
| request against the main branch. The PR-based workflow makes discussion | ||
| easier through inline review comments and suggested changes. | ||
|
|
||
| The JEP title should follow the format: | ||
|
|
||
| ```text | ||
| JEP: Short descriptive title | ||
| ``` | ||
|
|
||
| The PR number becomes the JEP number (e.g., PR #400 becomes JEP-0400). | ||
| Apply the `jep` label to the pull request. | ||
|
|
||
| Fill in every section of the template. Sections marked `(Optional)` may be | ||
| omitted if not applicable, but all required sections must be present. Set | ||
| the JEP status to **Proposed** when the PR is ready for review. | ||
|
|
||
| ### 3. Discussion and Revision | ||
|
|
||
| The community reviews the JEP on the pull request. PRs are the preferred | ||
| venue for discussion, as they allow inline review comments on the JEP text | ||
| itself. The author is expected to: | ||
|
|
||
| - Respond to feedback and revise the JEP accordingly. | ||
| - Build consensus, especially among contributors who would be affected by the | ||
| change. | ||
| - Document dissenting opinions in the **Rejected Alternatives** section. | ||
|
|
||
| ### 4. Decision | ||
|
|
||
| Jumpstarter maintainers make the final decision to accept or reject a JEP. | ||
| Decisions are recorded as a comment on the pull request with a rationale. The | ||
| author updates the JEP status in the markdown file. Rejected JEPs are closed | ||
|
||
| but not deleted — they remain as the historical record of why an approach was | ||
| not taken. | ||
|
|
||
| ### 5. Implementation | ||
|
|
||
| Once accepted, the author (or any willing contributor) implements the feature. | ||
| Implementation PRs should reference the JEP (e.g., `Implements JEP-0400`). | ||
| The JEP's **Implementation History** section should be updated with links | ||
| to relevant PRs as they are merged. The JEP moves through Implementing → | ||
| Implemented → Final as work progresses. | ||
|
|
||
| ## Roles | ||
|
|
||
| | Role | Responsibility | | ||
| |-----------------|----------------------------------------------------------------------------------------------| | ||
| | **Author** | Writes the JEP, responds to feedback, shepherds the proposal through the process. | | ||
| | **Reviewer** | Provides technical feedback on the pull request. Any community member can review. | | ||
| | **Maintainer** | Makes the final accept/reject decision. Must provide written rationale. | | ||
| | **Implementer** | Writes the code. Often the author, but doesn't have to be. | | ||
|
|
||
| ## JEP Numbering | ||
|
|
||
| JEP numbers are assigned from the pull request number used to submit the JEP. | ||
|
||
| Once assigned, a JEP number is never reused. JEP-0000 through JEP-0009 are | ||
| reserved for process and meta-JEPs. | ||
|
|
||
| ## JEP Index | ||
|
|
||
| The file `jeps/README.md` serves as the index of all JEPs. Alternatively, | ||
coderabbitai[bot] marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| all JEPs can be found by filtering GitHub pull requests with the `jep` label. | ||
|
|
||
| ## Amendments to This Process | ||
|
|
||
| Changes to the JEP process itself require a new Process-type JEP. | ||
|
|
||
| ## Prior Art | ||
|
|
||
| This process draws inspiration from: | ||
|
|
||
| - [Python Enhancement Proposals (PEPs)](https://peps.python.org/pep-0001/) — | ||
| lightweight metadata, champion model, clear status lifecycle. | ||
| - [Kubernetes Enhancement Proposals (KEPs)](https://github.com/kubernetes/enhancements/tree/master/keps) — | ||
| test plan requirements, graduation criteria, production readiness. | ||
| - [Rust RFCs](https://github.com/rust-lang/rfcs) — PR-based workflow, emphasis | ||
| on motivation and teaching, prior art section. | ||
|
|
||
| ## Copyright | ||
|
|
||
| This document is placed under the | ||
| [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0), | ||
| consistent with the Jumpstarter project license. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that using the PR number is not very deterministic, we should probably do sequential PRs. i.e. at the time of creating a new PR you can try to guess which number is next (counter is shared across issues and PRs, not sure if something else.)
I think it's just simpler to use a monotonic JEP counter, and manually fix when two competing PRs collide on the JEP number.
WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ambient-code Let's clartify that the JEP number is just an incrementing integer, not reflective of the PR#.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Clarified that JEP numbers are incrementing integers assigned sequentially, not derived from PR numbers. Updated the workflow section, the numbering section, the template metadata, and the README's agent-facing documentation to all reflect this.