Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
229 changes: 229 additions & 0 deletions enhancements/NNNN-template-complete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
<!--
# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of NVIDIA CORPORATION nor the names of its
# contributors may be used to endorse or promote products derived
# from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-->
# \<Title\>

**Status**: \[Draft | Under Review | Approved | Replaced | Deferred | Rejected\]

**Authors**: \[Name/Team\]

**Category**: \[Architecture | Process | Guidelines\]

**Replaces**: \[Link of previous proposal if applicable\]

**Replaced By**: \[Link of previous proposal if applicable\]

**Sponsor**: \[Name of code owner or maintainer to shepard process\]

**Required Reviewers**: \[Names of technical leads that are required for acceptance\]

**Review Date**: \[Date for review\]

**Pull Request**: \[Link to Pull Request of the Proposal itself\]

**Implementation PR / Tracking Issue**: \[Link to Pull Request or Tracking Issue for Implementation\]

## Summary

**\[Required\]**

## Motivation

**\[Required\]**

Describe the problem that needs to be addressed with enough detail for someone familiar with the project to understand.
Generally one to two short paragraphs.
Additional details can be placed in the background section as needed.
Cover **what** the issue is and **why** it needs to be addressed.
Link to github issues if relevant.

### Goals

**\[Optional \- if not applicable omit\]**

List out any additional goals in bullet points.
Goals may be aspirational / difficult to measure but guide the proposal.

* Goal

* Goal

* Goal

### Non Goals

**\[Optional \- if not applicable omit\]**

List out any items which are out of scope / specifically not required in bullet points.
Indicates the scope of the proposal and issue being resolved.

### Requirements

**\[Optional \- if not applicable omit\]**

List out any additional requirements in numbered subheadings.

**\<numbered subheadings\>**

#### REQ \<\#\> \<Title\>

Describe the requirement in as much detail as necessary for others to understand it and how it applies to the TEP.
Keep in mind that requirements should be measurable and will be used to determine if a TEP has been successfully implemented or not.

Requirement names should be prefixed using a monotonically increasing number such as “REQ 1 \<Title\>” followed by “REQ 2 \<Title\>” and so on.
Use title casing when naming requirements. Requirement names should be as descriptive as possible while remaining as terse as possible.

Use all-caps, bolded terms like **MUST** and **SHOULD** when describing each requirement.
See \[RFC-2119\](https://datatracker.ietf.org/doc/html/rfc2119) for additional information.

## Proposal

**\[Required\]**

Describe the high level design / proposal.
Use sub sections as needed, but start with an overview and then dig into the details.
Try to provide images and diagrams to facilitate understanding.

## Implementation Details

**\[Optional \- if not applicable omit\]**

Add additional detailed items here including interface signatures, etc.
Add anything that is relevant but seems more of a detail than central to the proposal.
Use sub sections / bullet points as needed.
Try to provide images and diagrams to facilitate understanding.
If applicable link to PR.

### Deferred to Implementation

**\[Optional \- if not applicable omit\]**

List out items that are under discussion but that will be resolved only during implementation / code review.

## Implementation Phases

**\[Optional \- if not applicable omit\]**

List out phases of implementation (can be single phase).
Give each phase a monotonically increasing number; example “Phase 0” followed by “Phase 1” and so on.
Give phases titles if it makes sense.

### Phase \<\#\> \<Optional Title\>

**Release Target**: Date

**Effort Estimate**: \<estimate of time and number of engineers to complete the phase\>

**Work Item(s):** \<one or more links to github issues\>

**Supported API / Behavior:**

* \<name and concise description of the API / behavior\>

**Not Supported:**

* \<name and concise description of the API / behavior\>

## Related Proposals

**\[Optional \- if not applicable omit\]**

* File

* File

* File

* File

* File

## Alternate Solutions

**\[Required, if not applicable write N/A\]**

List out solutions that were considered but ultimately rejected.
Consider free form `-`, but a possible format shown below.

### Alt \<\#\> \<Title\>

**Pros:**

\<bulleted list or pros describing the positive aspects of this solution\>

**Cons:**

\<bulleted list or pros describing the negative aspects of this solution\>

**Reason Rejected:**

\<bulleted list or pros describing why this option was not used\>

**Notes:**

\<optional: additional comments about this solution\>

## Background

**\[Optional \- if not applicable omit\]**

Add additional context and references as needed to help reviewers and authors understand the context of the problem and solution being proposed.

## References

**\[Optional \- if not applicable omit\]**

Add additional references as needed to help reviewers and authors understand the context of the problem and solution being proposed.

* \<hyper-linked title of an external reference resource\>

## Terminology & Definitions

**\[Optional \- if not applicable omit\]**

List out additional terms / definitions (lexicon).
Try to keep definitions as concise as possible and use links to external resources when additional information would be useful to the reader.

Keep the list of terms sorted alphabetically to ease looking up definitions by readers.

| \<Term\> | \<Definition\> |
| :---- | :---- |
| **\<Term\>** | \<Definition\> |

## Acronyms & Abbreviations

**\[Optional \- if not applicable omit\]**

Provide a list of frequently used acronyms and abbreviations which are uncommon or unlikely to be known by the reader.
Do not include acronyms or abbreviations which the reader is likely to be familiar with.

Keep the list of acronyms and abbreviations sorted alphabetically to ease looking up definitions by readers.

Do not include the full definition in the expanded meaning of an abbreviation or acronym.
If the reader needs the definition, please include it in the \[Terminology & Definitions\](#terminology--definitions) section.

**\<Acronym/Abbreviation\>:** \<Expanded Meaning\>
134 changes: 134 additions & 0 deletions enhancements/NNNN-template-limited.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
<!--
# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of NVIDIA CORPORATION nor the names of its
# contributors may be used to endorse or promote products derived
# from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-->
# \<Title\>

**Status**: \[Draft | Under Review | Approved | Replaced | Deferred | Rejected\]

**Authors**: \[Name/Team\]

**Category**: \[Architecture | Process | Guidelines\]

**Replaces**: \[Link of previous proposal if applicable\]

**Replaced By**: \[Link of previous proposal if applicable\]

**Sponsor**: \[Name of code owner or maintainer to shepard process\]

**Required Reviewers**: \[Names of technical leads that are required for acceptance\]

**Review Date**: \[Date for review\]

**Pull Request**: \[Link to Pull Request of the Proposal itself\]

**Implementation PR / Tracking Issue**: \[Link to Pull Request or Tracking Issue for Implementation\]

## Summary

**\[Required\]**

## Motivation

**\[Required\]**

Describe the problem that needs to be addressed with enough detail for someone familiar with the project to understand.
Generally one to two short paragraphs.
Additional details can be placed in the background section as needed. Cover **what** the issue is and **why** it needs to be addressed.
Link to github issues if relevant.

### Goals

**\[Optional \- if not applicable omit\]**

List out any additional goals in bullet points.
Goals may be aspirational / difficult to measure but guide the proposal.

* Goal

* Goal

* Goal

#### Non Goals

**\[Optional \- if not applicable omit\]**

List out any items which are out of scope / specifically not required in bullet points.
Indicates the scope of the proposal and issue being resolved.

### Requirements

**\[Optional \- if not applicable omit\]**

List out any additional requirements in numbered subheadings.

**\<numbered subheadings\>**

#### REQ \<\#\> \<Title\>

Describe the requirement in as much detail as necessary for others to understand it and how it applies to the TEP.
Keep in mind that requirements should be measurable and will be used to determine if a TEP has been successfully implemented or not.

Requirement names should be prefixed using a monotonically increasing number such as “REQ 1 \<Title\>” followed by “REQ 2 \<Title\>” and so on.
Use title casing when naming requirements.
Requirement names should be as descriptive as possible while remaining as terse as possible.

Use all-caps, bolded terms like **MUST** and **SHOULD** when describing each requirement.
See \[RFC-2119\](https://datatracker.ietf.org/doc/html/rfc2119) for additional information.

## Proposal

**\[Required\]**

Describe the high level design / proposal.
Use sub sections as needed, but start with an overview and then dig into the details.
Try to provide images and diagrams to facilitate understanding.

## Alternate Solutions

**\[Required, if not applicable write N/A\]**

List out solutions that were considered but ultimately rejected.
Consider free form `-`, but a possible format shown below.

## Alt \<\#\> \<Title\>

**Pros:**

\<bulleted list or pros describing the positive aspects of this solution\>

**Cons:**

\<bulleted list or pros describing the negative aspects of this solution\>

**Reason Rejected:**

\<bulleted list or pros describing why this option was not used\>

**Notes:**

\<optional: additional comments about this solution\>
Loading
Loading