Skip to content

Commit

Permalink
[feature_file] Create feature process file
Browse files Browse the repository at this point in the history
As discussed in process and tracking tool discussion, port Brian's table
to adoc format in this repo
  • Loading branch information
jasondlee committed Jul 3, 2024
1 parent d659b3a commit 946b2f3
Showing 1 changed file with 117 additions and 0 deletions.
117 changes: 117 additions & 0 deletions FEATURE_PROCESS.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
= 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.

[cols="5"]
|===
|
|Experimental
|Preview
|Community
|Default
|Feature Team
|Component lead or other SME
|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
|Approved WildFly Proposals document

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

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

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

Code style standards followed.

Management API has experimental metadata

Feature not used at runtime if not in experimental level

New libraries not provisioned if not in appropriate stability level ???

Third party libraries in Final version??
|All hard requirements in analysis covered

Management API has preview metadata

Feature not used at runtime if not in preview level

New libraries not provisioned if not in appropriate stability level ???
|Stable API and behavior.

All hard requirements in analysis covered

Management API has community metadata

Feature not used at runtime if not in community level

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
|Acceptable Open Source License
|Experimental plus:

Uses maintained components

Component available from JBoss Nexus or maven central
|Preview plus:

Uses up-to-date maintained components
|Community plus:

Identified maintainer
|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.

Smoke tests of main functional areas.
|Standard subsystem tests.

Test coverage as per test plan.
|Standard subsystem tests.

Test coverage as per test plan.
|Standard subsystem tests

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

Documentation content as per analysis.
|Correct management API metadata

Documentation content as per analysis.
|Correct management API metadata

Documentation content as per analysis.
|===

0 comments on commit 946b2f3

Please sign in to comment.