Skip to content

Commit

Permalink
Merge pull request #1 from jmesnil/jasondlee-feature_file
Browse files Browse the repository at this point in the history
Update table for readability
  • Loading branch information
jasondlee committed Jul 9, 2024
2 parents 946b2f3 + d0a5d3c commit a24f9ec
Showing 1 changed file with 66 additions and 44 deletions.
110 changes: 66 additions & 44 deletions FEATURE_PROCESS.adoc
Original file line number Diff line number Diff line change
@@ -1,33 +1,38 @@
= WildFly Feature Development Process

WildFly features can have one of four different maturity levels, “Experimental”, “Preview”, “Community” and an unnamed default level. Promotion from one level to another, or initial feature incorporation at a given level, requires meeting various standards in the basic areas of requirements analysis, implementation, testing and documentation. The following table outlines the various standards for each of the maturity levels.
WildFly features can have one of four different maturity levels, “Experimental”, “Preview”, “Community” and an unnamed default level.

Promotion from one level to another, or initial feature incorporation at a given level, requires meeting various standards in the basic areas of requirements analysis, implementation, testing and documentation. The following table outlines the various standards for each of the maturity levels.

[cols="5"]
|===
|
|Experimental
|Preview
|Community
|Default
|Feature Team
| | Experimental | Preview | Community | Default

//-------
| *Feature Team*
|Component lead or other SME
|Experimental plus: +
|Experimental plus:

3rd party with a different perspective, able to question the feature requirements and API
|Preview plus:
|Community plus:
|Requirement Analysis
|Understandable JIRA description with an orientation toward what/why and not just how
| same as Preview
| same as Community
//-------


//-------
| *Requirement Analysis*
| Issue tracker with an understandable description with an orientation toward what/why and not just how
|Approved WildFly Proposals document

Nice-to-have requirements allowed.
|Approved WildFly Proposals document
|Preview plus:

Nice-to-have requirements have been converted to non-requirements or are moved to a future work section.
|Approved WildFly Proposals document
|Same as Community
//-------

Nice-to-have requirements have been converted to non-requirements or are moved to a future work section
|Implementation
//-------
| *Implementation*
|Primary use cases covered.

Code style standards followed.
Expand Down Expand Up @@ -58,12 +63,16 @@ New libraries not provisioned if not in appropriate stability level ???
|Stable API and behavior

All hard requirements in analysis covered
|Domain Transformation
|Encouraged
|Encouraged
|Encouraged
|Required
|Component Validation
//-------

//-------
| *Domain Transformation*
| Encouraged |Encouraged |Encouraged |Required
//-------


//-------
| *Component Validation*
|Acceptable Open Source License
|Experimental plus:

Expand All @@ -76,42 +85,55 @@ Uses up-to-date maintained components
|Community plus:

Identified maintainer
|Test Plan
//-------


//-------
| *Test Plan*
|Not required
|Required -- TODO what it means
|Required -- TODO what it means
|Formal test plan approved by a professional Quality Engineer with subject matter expertise
|Test Development
|Standard subsystem tests.
|Same as Preview
|Community plus:

Smoke tests of main functional areas.
Formal test plan approved by a professional Quality Engineer with subject matter expertise
//-------


//-------
| *Test Development*
|Standard subsystem tests.

Test coverage as per test plan.
Smoke tests of main functional areas.
|Standard subsystem tests.

Test coverage as per test plan.
|Standard subsystem tests
| Same as Experimental
| Community plus:

Domain transformation tests
//-------

Test coverage as per test plan
|Test Verification
|Code review and CI
|Code review and CI
|Code review and CI
|Verification by a professional Quality Engineer with subject matter expertise
|Documentation
|Understandable JIRA description.

Correct management API metadata
|Correct management API metadata
//-------
| *Test Verification*
| Code review and CI
| Same as Experimental
| Same as Preview
| Community plus:

Documentation content as per analysis.
|Correct management API metadata
Verification by a professional Quality Engineer with subject matter expertise
//-------

Documentation content as per analysis.
|Correct management API metadata

//-------
| *Documentation*
|Understandable JIRA description.

Correct management API metadata
| Experimental plus:

Documentation content as per analysis.
| Same as Preview
| Same as Community
//-------
|===

0 comments on commit a24f9ec

Please sign in to comment.