Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

specs: try to make it clear what deliverables should be #2495

Merged
merged 2 commits into from
Aug 1, 2023
Merged

specs: try to make it clear what deliverables should be #2495

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
372c361
specs: try to make it clear what deliverables should be
antoniivanov Jul 28, 2023
470b8f0
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions specs/NNNN-template/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,13 @@ Explain the user problem that need to be solved.

## Requirements and goals
<!--
It tells **what** is it trying to achieve?
List the specific goals (functional and nonfunctional requirements)? How will we
know that this has succeeded?
It tells **what** is it trying to achieve including expected deliverables.
List the specific goals (functional and nonfunctional requirements)?
It's recommended to specify metrics that can be used to check the goal has been achieved.

Specify for what type of users, what is going to be delivered.
Recommended (but not required format) is
User <persona/type of user>, they need <new deliverable/feature/improvement>, so that <reason>

Specify non-goals. Clearly, the list of non-goals can't be exhaustive.
Non-goals are only features, which a contributor can reasonably assume were a goal.
Expand Down Expand Up @@ -151,7 +155,8 @@ Consider at least the below topics but you do not need to cover those that are n

## Implementation stories
<!--
Optionally, describe what are the implementation stories (eventually we'd create github issues out of them).
Optionally, describe what are the implementation stories. Link to Milestone or initiative in Github is fine
As part of the implementation make sure to include stories covering release/launch plan, promotional activities before the release,
-->

## Alternatives
Expand Down