Skip to content

Commit

Permalink
Merge pull request kubernetes#3 from brian-avery/master
Browse files Browse the repository at this point in the history
Add templates for promoting features
  • Loading branch information
linsun authored Sep 22, 2020
2 parents 1abe716 + d9b800c commit a36969a
Show file tree
Hide file tree
Showing 4 changed files with 186 additions and 0 deletions.
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/alpha_feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
name: Alpha Feature Requirements
about: Requirements for promoting a feature to alpha
---

# Alpha Feature Requirements

This page lists the requirements for promoting a feature to alpha. Please check off and document the steps as they are completed.

**Feature Name:**

**RFC:**

**Design doc:**

**Relevant Documentation:**

---

### Requirements:

**Design**

- [ ] RFC has been approved describing the intention of the feature as well as the user stories behind the feature.

**Config**

- [ ] Explicit user action is required to enable this feature (e.g. a config field, config resource, or installation action).

> Link to instructions for enabling
**Docs**

- [ ] Reference docs are published to preliminary.istio.io or the Istio wiki.
- [ ] Basic feature docs are published on preliminary.istio.io describing what the feature does, how to use it, and any caveats.
- [ ] Release notes entries added as appropriate
- [ ] Upgrade notes entries added as appropriate

**Tests**

- [ ] Automated integration tests cover core use cases with the feature enabled.
- [ ] When disabled, the feature does not affect system stability or performance.

**API**

- [ ] Initial API review.

**Approvals**

- [ ] The appropriate work group(s) have reviewed and approved promotion of the feature.
- [ ] The TOC has reviewed and approved promotion of the feature as part of the
roadmap for a release.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/beta_feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
name: Beta Feature Requirements
about: Requirements for promoting a feature to beta
---

# Beta Feature Requirements

This page lists the requirements for promoting a feature to beta. Promotion to beta must meet all requirements for promotion to alpha. Please check off and document the steps as they are completed.

**Feature Name:**

**Design Doc:**

**Alpha Checklist:**

**Relevant Documentation:**

---

### Requirements:

**Design**

- [ ] Design doc describing the intention of the feature, how it will be
implemented, and any thoughts on how to test the feature has been approved by
relevant work group leads
- [ ] Feature coverage and test plans written and approved.

**Docs**

- [ ] Documentation on istio.io includes performance expectations; may have caveats.
- [ ] Documentation on istio.io includes samples/tutorials.
- [ ] Documentation on istio.io includes appropriate glossary entries.
- [ ] All new documentation containing user actions includes istio.io tests.
- [ ] Release notes have been added.
- [ ] Upgrade notes have been added.

**Tests**

- [ ] Integration tests cover feature edge cases
- [ ] End-to-end tests cover samples/tutorials
- [ ] Fixed issues have tests to prevent regressions
- [ ] Stability/stress test suite includes coverage for the feature.

**Performance**

- [ ] Feature coverage and test plans written and approved
- [ ] Tests exist with the feature enabled that can be integrated with our automated performance testing.

**API**

- [ ] TOC has reviewed the API and determined it to be complete.

**Tooling**

- [ ] Any necessary tooling to use/debug the feature has been implemented and is complete.

**Bugs**

- [ ] Feature has no known major issues.

**Approvals**

- [ ] The appropriate work group(s) have reviewed and approved promotion of the feature.
- [ ] The supportability review panel has reviewed promotion of the feature.
- [ ] The TOC has reviewed and approved promotion of the feature as part of the
road map for a release.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/experimental_feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Experimental Feature Requirements
about: Requirements for experimental features
---

# Experimental Feature Requirements

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.

**Feature Name:**

---

### Requirements:

- [ ] 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.

> Link to instructions
- [ ] Plan exists for getting feedback. This may include user feedback meetings,
discuss.istio.io conversations, GitHub issues, or mailing lists.

> Plan for feedback
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/stable_feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Stable Feature Requirements
about: Requirements for promoting a feature to stable
---

# Stable Feature Requirements

This page lists the requirements for promoting a feature to stable. Promotion to stable must meet all requirements of promotion to beta. Please check off and document the steps as they are completed.

**Feature Name:**

**Alpha Checklist:**

**Beta Checklist:**

**Relevant Documentation:**

---

### Requirements:

**Performance**

- [ ] Latency, throughput, and scalability are quantified and documented on
istio.io.

**Bugs**

- [ ] Feature has no known major issues.

**Approvals**

- [ ] The appropriate work group(s) have reviewed and approved promotion of the feature.
- [ ] The supportability review panel has reviewed promotion of the feature.
- [ ] The TOC has reviewed and approved promotion of the feature as part of the
roadmap for a release.

0 comments on commit a36969a

Please sign in to comment.