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

Update API_REVIEW.md #564

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update API_REVIEW.md #564

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 44 additions & 1 deletion .github/API_REVIEW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,47 @@
# API Review
#### Summary

> A brief of the new API, including a code sample. Consider where this feature
> would fit into our documentation, and what the updated documentation would
> look like.

<!-- TODO -->

#### Motivation

> Describe the problem you are trying to solve with this API change. What does
> this API enable that was previously not possible?

<!-- TODO -->

#### Similar APIs

> Is this new API similar to an existing Stripe API? Are there similar APIs or
> prior art in other popular projects?

<!-- TODO -->

#### Alternatives

> How else could we implement this feature? Are there any existing workarounds
> that would offer the same functionality? Why should we chose this
> implementation over another?

<!-- TODO -->

#### Scope

> Which interfaces will this apply to? For example, is this specific to one
> component, or does it affect all Element components? Does this set a precedent
> for future interfaces we'll add?

<!-- TODO -->

#### Risks

> Are there any security implications (for example, XSS)? What are some ways
> users might get confused or misuse this feature?

<!-- TODO --># API Review

All API changes should go through API review, in addition to our normal code
review process. We define an API change as
Expand Down