Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 1.77 KB

README.md

File metadata and controls

40 lines (31 loc) · 1.77 KB

Snapshot Enhancement Proposal (SNEP)

A Snapshot Enhancement Proposal (SNEP) is the design document for a significant Snapshot improvement, new feature, or change. It explains the intended change and its motivation, then records the design, trade-offs, and validation plan. SNEPs give maintainers and the community a focused place to discuss a change before implementation begins.

How to file an SNEP

Submit SNEPs as Markdown files in a GitHub pull request. Follow these rules:

  1. Create a tracking issue. Its issue number is also the SNEP number.
  2. Create a descriptively named directory under docs/design, prefixed with that number—for example, docs/design/123-multi-gpu-support.
  3. Name the proposal document README.md.
  4. Start with the SNEP template.
  5. Generate the table of contents with make update-toc before opening or updating the pull request. Check it without modifying files by running make verify-toc.

When working with a compatible coding agent, invoke the repository's $snep skill for a guided, section-by-section proposal draft. The skill is located at .agents/skills/snep and follows this process and the template; it does not replace proposal review.

SNEP is inspired by the Kubernetes Enhancement Proposal (KEP) process and the Grove Enhancement Proposal (GREP) convention.

Why does an SNEP directory start with a number?

The directory prefix is the tracking issue number. It supplies a stable, unique identifier for the SNEP and connects the design directly to the issue where its status and implementation work are tracked.