Skip to content

Latest commit

 

History

History
67 lines (37 loc) · 2.25 KB

0000-rfc-template.md

File metadata and controls

67 lines (37 loc) · 2.25 KB
Status Champions PR
Active
{"your_github_username" => nil}
{"update_with_pr_number" => nil}

{{ TITLE }}

Brief summary paragraph describing the RFC.

Objective

What is the RFC trying to accomplish?

Goals

  • Specific goals of the RFC

Non-Goals

  • Specific non-goals of the RFC

Motivation

Why is the RFC neccessary? What background information is needed to understand why?

Detailed Design

Describe the change in detail. Include API changes and usage examples. Add your own sub-headings as necessary.

Implementation Considerations

Implementation Plan

Is there anything important to note about implementation plan? Can it be done in a single PR or will it need to be staged out across several?

Backward Compatibility

Backwards compatibility is extremely important to Lit, especially in the core libraries. Does this proposal break backwards compatibility? Are there workarounds?

Testing Plan

How will this proposal be tested? Are unit tests sufficient, or do we need integration tests? Is any unique testing infrastructure required?

Performance and Code Size Impact

What impact will this proposal have on performance and code size? What benchmarks should we create to evaluate the proposal?

Interoperability

Is this proposal for a feature that could be interoperable across web components not written in Lit? Does it create a tight coupling between components written in Lit? Could it be a Web Components Community Group Community Protocol?

Security Impact

What impact will this proposal have on security? Does the proposal require a security review? (We have a security team available for reviews)

We especially care about the handling of untrusted user input by library code so that we contnue to prevent XSS vectors.

Documentation Plan

Do we need to create or update any documentation to complete this proposal? Does related documentation have a clear home in our docs outline? What playground examples or tutorials should be created?

Downsides

Many proposals involve trade-offs. What are they for this proposal and what are the downsides of this approach?

Alternatives

What alternatives were considered and rejected? Why?