[Iris 2.0] Feature Spec Template

Iris 2.0 Feature Template

Replace the page title with "[Iris 2.0] Feature Name", e.g.

[Iris 2.0] Hello World

Title:

Author(s):

Your name

Tracking issue:

Link to the associated Github issue(s).

Short description:

Brief, one-sentence synopsis.

Use case(s):

How does one use this feature, and why? What problem is it solving?

Implementation:

• Overview

More details about how you will create this feature.

• Sample code

Either real or pseudo code to describe what the logic will look like. Use code formatting for better readability.

• New and/or changed files and directories

List of additions/changes to the project structure - estimated.

• Control Center

What impact, if any, does this feature have on the Control Center? Think about runtime arguments, test case format, and anything that will display in the Control Center web page.

• Localization

Does this feature impact localization?

• Documentation

Will this feature require new docs, or changes to existing ones?

• Bootstrap

Does this feature require changes or additions to the bootstrap scripts? What software and/or system configs are required?

• Setup

Does this feature require new Python libraries, or otherwise affect the setup process?

Risks:

• Dependencies on other people/teams/software.

Is this feature ready to be implemented or are we waiting for others? Are there any outstanding (or potential) issues in dependent software that we need to be aware of?

• Other factors that could influence functionality or schedule.

Do you anticipate any changes that could impact your design?

Estimated schedule:

• xxxx-xx-xx Spec due date (this)
• xxxx-xx-xx Implementation
• xxxx-xx-xx Code review
• xxxx-xx-xx Testing
• xxxx-xx-xx Final check-in date