Skip to content

Commit 7b892d6

Browse files
authored
docs: Event Stream design (#460)
* docs: Event Stream design
1 parent e7be867 commit 7b892d6

File tree

2 files changed

+638
-0
lines changed

2 files changed

+638
-0
lines changed

design/rfc-00000-template.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# RFC template
2+
3+
* Inspired from
4+
https://github.com/apple/swift-evolution/blob/main/proposal-templates/0000-swift-template.md
5+
* Keep line length between 80-120 (80 recommended) ignoring URIs/links that
6+
can't be broken. Recommended to use
7+
https://marketplace.visualstudio.com/items?itemName=stkb.rewrap
8+
* Include diagrams in your Markdown files with
9+
[Mermaid](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/)
10+
11+
* * *
12+
13+
# Feature name
14+
15+
* Proposal: [RFC-00001](design/rfc-00001-event-stream.md)
16+
* Authors: [Author 1](https://github.com/awsdev),
17+
[Author2](https://github.com/awsdev)
18+
19+
* Status: **Awaiting implementation | Implemented | Review | Rejected
20+
**
21+
22+
## Introduction
23+
24+
A short description of what the feature is. Try to keep it to a single-paragraph
25+
"elevator pitch" so the reader understands what problem this proposal is
26+
addressing
27+
28+
## Motivation
29+
30+
Describe the problems that this proposal seeks to address. If this is a new
31+
feature, describe the problems that the feature will solve.
32+
33+
## Proposed solution
34+
35+
Describe your solution to the problem. Provide examples and describe how they
36+
work. Show how your solution is better than current workarounds: is it cleaner,
37+
safer, or more efficient?
38+
39+
## Detailed design
40+
41+
Describe the design of the solution in detail. If it's a new API, show the full
42+
API and its documentation comments detailing what it does. The detail in this
43+
section should be sufficient for someone who is *not* one of the authors to be
44+
able to reasonably implement the feature.
45+
46+
## Source compatibility
47+
48+
Will existing SDK applications stop compiling due to this change? Will
49+
applications still compile but produce different behavior than they used to?
50+
51+
We should only break source compatibility if absolutely necessary. It's better
52+
to deprecate and provide a migration path.
53+
54+
## Alternatives considered
55+
56+
Describe alternative approaches to addressing the same problem, and why you
57+
chose this approach instead.
58+
59+
## Acknowledgments
60+
61+
If significant changes or improvements suggested by members of the community
62+
were incorporated into the proposal as it developed, take a moment here to thank
63+
them for their contributions. AWS SDK for Swift RFC is a collaborative process,
64+
and everyone's input should receive recognition!

0 commit comments

Comments
 (0)