Skip to content

JEP-0011: Protobuf Introspection and Interface Generation#565

Open
kirkbrauer wants to merge 2 commits intomainfrom
jep-0011-proposal
Open

JEP-0011: Protobuf Introspection and Interface Generation#565
kirkbrauer wants to merge 2 commits intomainfrom
jep-0011-proposal

Conversation

@kirkbrauer
Copy link
Copy Markdown
Member

@kirkbrauer kirkbrauer commented Apr 16, 2026

Propose adding protobuf introspection to allow non-Python clients to discover driver APIs. Introduces FileDescriptorProto as the schema format and enables bidirectional CLI tooling (jmp proto export, jmp proto generate, jmp proto check).

For a full reference implementation, please see: https://github.com/jumpstarter-dev/jumpstarter/tree/jep-11-protobuf-introspection

Propose adding protobuf introspection to allow non-Python clients to
discover driver APIs. Introduces FileDescriptorProto as the schema
format and enables bidirectional CLI tooling (jmp proto export,
jmp proto generate, jmp proto check).
@kirkbrauer kirkbrauer added the enhancement New feature or request label Apr 16, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 16, 2026

📝 Walkthrough

Walkthrough

Documentation infrastructure for Jumpstarter Enhancement Proposals (JEPs) is established by introducing a new index page that catalogs JEPs with their status and authors, while updating the contributing guide's table of contents to reference this new documentation section.

Changes

Cohort / File(s) Summary
JEP Documentation Infrastructure
python/docs/source/contributing.md, python/docs/source/internal/jeps/index.md
Added new JEP index documentation page with table of proposals and Sphinx toctree configuration. Updated contributing guide's toctree to include the new JEP documentation section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • raballew
  • NickCao
  • bennyz

Poem

🐰 A carrot-filled garden of proposals now grows,
Where JEPs are listed in neat, ordered rows,
With status and authors for all to see clear,
The enhancement path shines ever sincere! 📖✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title directly references JEP-0011 and its specific purpose (Protobuf Introspection and Interface Generation), which matches the core content of the new documentation page added in this PR.
Description check ✅ Passed The description is directly related to the changeset, explaining the protobuf introspection proposal and linking to the reference implementation, which aligns with the new JEP-0011 documentation page being added.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch jep-0011-proposal

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.


| Field | Value |
| ----------------- | ----------------------------------------------------- |
| **JEP** | 0011 |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why 0011? :D wouldn't it be 2 ?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or 0010 😅

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lol ❤️

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JEP-0-9 are reserved for process improvements and JEP-10 already exists.

@kirkbrauer
Copy link
Copy Markdown
Member Author

@ambient-code Please update the TOCTREE and main index file for the JEPs to include this proposal.

Add a JEPs index page listing JEP-0011 and include it in the
contributing section toctree so proposals are discoverable from the
main documentation navigation.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@ambient-code
Copy link
Copy Markdown
Contributor

ambient-code bot commented Apr 16, 2026

Done — added a JEPs index page at python/docs/source/internal/jeps/index.md listing JEP-0011, and wired it into the contributing section toctree so proposals are discoverable from the main docs navigation.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
python/docs/source/internal/jeps/index.md (1)

3-6: Consider linking the JEP process doc here.

To reduce ambiguity for first-time proposal authors, add a direct link to the JEP process document in this intro section.

Suggested doc tweak
 JEPs are the primary mechanism for proposing significant changes to
 Jumpstarter. Each JEP is submitted as a pull request containing a Markdown
 document that describes the motivation, design, and implementation plan for
 the proposed change.
+For process details, see
+[`JEP-0000: JEP Process`](../../../jeps/JEP-0000-jep-process.md).
Based on learnings, the project’s process document is located at `jeps/JEP-0000-jep-process.md`.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@python/docs/source/internal/jeps/index.md` around lines 3 - 6, Add a direct
link to the JEP process document in the intro paragraph of the JEP index so
first-time authors can find the process easily; edit the text that begins "JEPs
are the primary mechanism..." in the jeps index and append or replace a sentence
with a clear relative link to the process doc (jeps/JEP-0000-jep-process.md) and
a short phrase like "see the JEP process document" so readers can jump directly
to the guidelines.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@python/docs/source/internal/jeps/index.md`:
- Around line 3-6: Add a direct link to the JEP process document in the intro
paragraph of the JEP index so first-time authors can find the process easily;
edit the text that begins "JEPs are the primary mechanism..." in the jeps index
and append or replace a sentence with a clear relative link to the process doc
(jeps/JEP-0000-jep-process.md) and a short phrase like "see the JEP process
document" so readers can jump directly to the guidelines.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a9f28d7f-141f-4ae5-b20b-88468446d8a2

📥 Commits

Reviewing files that changed from the base of the PR and between fcbbfbf and 841f8ce.

📒 Files selected for processing (3)
  • python/docs/source/contributing.md
  • python/docs/source/internal/jeps/JEP-0011-protobuf-introspection-interface-generation.md
  • python/docs/source/internal/jeps/index.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants