SMT-NNNN.md 1.6 KB

SMT-NNNN: Feature name

Feature abstract – a one sentence summary.

Overview

Introduction

A short, one-sentence overview of the feature or change.

Motivation

Describe the problems that this proposal addresses, and what workarounds adopters currently use, if any.

Proposed solution

Describe your solution to the problem. Provide examples and describe how they work. Show how your solution is better than current workarounds.

Focus this section on what will change for the adopters of Swift Metrics.

Detailed design

Describe the implementation of the feature. Include a link to a prototype implementation.

Focus this section on what will change for the contributors to Swift Metrics.

API stability

Discuss the API implications, making sure to consider all of:

  • existing MetricsFactory implementations
  • existing users of Metrics

Future directions

Discuss any potential future improvements to the feature.

Alternatives considered

Discuss the alternative solutions you considered, even during the review process itself.