forked from kubernetes/enhancements
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request kubernetes#4 from sdake/master
This improves the experimental feature template
- Loading branch information
Showing
1 changed file
with
52 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,64 @@ | ||
--- | ||
name: Experimental Feature Requirements | ||
about: Requirements for experimental features | ||
about: Requirements for an experimental feature | ||
--- | ||
|
||
# Experimental Feature Requirements | ||
[//]: # (The syntax preceeding this line is a comment marker used to help guide the issue author with submission of an issue) | ||
[//]: # (to github. Unlike HTML comments commonly used throughout istio.io documentation, this comment will not be rendered) | ||
[//]: # (by github. Comments must be separated by carriage return preceding and concluding the text and be a single line.) | ||
|
||
This page lists the requirements for experimental features. Experimental features allow Istio work groups to collect more information | ||
on potential new functionality. This template should be completed before users try out any new experimental features. Please check off and | ||
document the steps as they are completed. | ||
[//]: # (This page lists the requirements for an experimental feature. Completion of this template enables Istio work groups) | ||
[//]: # (to collect information on potential new functionality. This template should be completed before users are exposed to) | ||
[//]: # (any new experimental feature. Please complete this template during development.) | ||
|
||
**Feature Name:** | ||
[//]: # (The feature implementation section must be completed before submission of the issue.) | ||
|
||
--- | ||
# Feature: | ||
|
||
### Requirements: | ||
[//]: # (All information in this section is mandatory for new issue submission.) | ||
|
||
- [ ] Feature is reviewed in a work group meeting | ||
- [ ] RFC has been written | ||
- [ ] Feature is disabled by default | ||
- [ ] No impact on performance when the feature is disabled. | ||
- [ ] Steps for enabling the feature have been documented. This may include | ||
instructions for building, running an `istioctl experimental command`, or | ||
using the preview profile. | ||
**Feature name:** | ||
|
||
[//]: # (The name of the feature, e.g. Multiple control planes) | ||
|
||
**Primary lead(s):** | ||
|
||
[//]: # (The primary lead or leads responsible for the feature. These individuals serve as a point of contact for the feature.) | ||
|
||
**Short description:** | ||
|
||
[//]: # (A short description of the feature. One or two sentences maximum.) | ||
|
||
# Requirements: | ||
|
||
[//]: # (All information in this section is mandatory for promotion. Please edit the issue to modify the links in this) | ||
[//]: # (section.) | ||
|
||
- [ ] [User stories](insert_your_link_here) reviewed in a work group meeting. | ||
|
||
> Link to instructions | ||
[//]: # (User stories are a way to communicate user value. User stories follow the style) | ||
[//]: # (as a [type of user], I want [an action] so that [a benefit/a value]. Istio currently has no user) | ||
[//]: # (story template. Maybe you can make one?) | ||
|
||
- [ ] Plan exists for getting feedback. This may include user feedback meetings, | ||
discuss.istio.io conversations, GitHub issues, or mailing lists. | ||
[//]: # (User stories must be presented in a work group meeting. They need no approval and are later integrated) | ||
[//]: # (into the RFCs, which do need approval for alpha. You may find value to negotiate within the work group where the) | ||
[//]: # (user stories are presented to help clarify the user stories.) | ||
|
||
> Plan for feedback | ||
- [ ] [RFC Authored] - [create an RFC using template](https://docs.google.com/document/d/1ewJoCcw5-04crH-M0xw4zFxz1cfwVCPnNyW4K3m4Yyc/template/preview). | ||
|
||
[//]: # (An RFC is mandatory to graduate to experimental. The RFC does not have to be reviewed in a work group) | ||
[//]: # (meeting to graduate to experimental.) | ||
|
||
- [ ] [Documentation](insert_your_link_here) for enabling and using the feature. | ||
|
||
[//]: # (The documentation instructions may exist on the developer wiki or the team drive. They may include instructions) | ||
[//]: # (for building running a `istioctl experimental command`, or using the preview profile,) | ||
[//]: # (or any other relevant information.) | ||
|
||
- [ ] [Feedback plan](insert_your_link_here). | ||
|
||
[//]: # (This may include user feedback meetings, discuss.istio.io conversations, GitHub issues, or mailing lists.) | ||
|
||
- [ ] Disabled by default. | ||
|
||
- [ ] No impact on performance when the feature is disabled. |