Skip to content

Commit

Permalink
fix: enhancement template typos
Browse files Browse the repository at this point in the history
Signed-off-by: Chin-Ya Huang <chin-ya.huang@suse.com>
  • Loading branch information
c3y1huang authored and innobead committed Aug 25, 2022
1 parent 6f885bf commit cccabbf
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions enhancements/YYYYMMDD-template.md
Expand Up @@ -6,13 +6,13 @@ The file name should be lowercased and spaces/punctuation should be replaced wit

## Summary

The Summary section is incredibly important for producing high quality user-focused documentation such as release notes or a development roadmap.
The Summary section is incredibly important for producing high-quality user-focused documentation such as release notes or a development roadmap.

A good summary is probably at least a paragraph in length.

### Related Issues

The URL For the related enhancement issues in Longhorn repo.
The URL For the related enhancement issues in the Longhorn repository.

## Motivation

Expand All @@ -26,10 +26,10 @@ What is out of scope for this enhancement? Listing non-goals helps to focus disc

## Proposal

This is where we get down to the nitty gritty of what the proposal actually is.
This is where we get down to the nitty-gritty of what the proposal actually is.

### User Stories
Detail the things that people will be able to do if this enhancement is implemented. A good practise is including a comparison of what user cannot do before the enhancement implemented, why user would want an enhancement and what user need to do after, to make it clear why the enhancement beneficial to the user.
Detail the things that people will be able to do if this enhancement is implemented. A good practice is including a comparison of what the user cannot do before the enhancement is implemented, why the user would want an enhancement, and what the user needs to do after, to make it clear why the enhancement is beneficial to the user.

The experience details should be in the `User Experience In Detail` later.

Expand All @@ -38,15 +38,15 @@ The experience details should be in the `User Experience In Detail` later.

### User Experience In Detail

Detail what user need to do to use this enhancement. Include as much detail as possible so that people can understand the "how" of the system. The goal here is to make this feel real for users without getting bogged down.
Detail what the user needs to do to use this enhancement. Include as much detail as possible so that people can understand the "how" of the system. The goal here is to make this feel real for users without getting bogged down.

### API changes

## Design

### Implementation Overview

Overview on how the enhancement will be implemented.
Overview of how the enhancement will be implemented.

### Test plan

Expand All @@ -56,8 +56,8 @@ For engine enhancement, also requires engine integration test plan.

### Upgrade strategy

Anything that requires if user want to upgrade to this enhancement
Anything that requires if the user wants to upgrade to this enhancement.

## Note [optional]

Additional nodes.
Additional notes.

0 comments on commit cccabbf

Please sign in to comment.