Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 2.82 KB

0000-template.md

File metadata and controls

79 lines (56 loc) · 2.82 KB
Feature Feature Name Goes Here
Submitted 2024-12-01
Accepted No
Issue https://youtrack.jetbrains.com/issue/KTOR-0000/
Preceded by
Followed by

Contents

  1. Summary
  2. Motivation
  3. Current Solutions
  4. Design Overview
  5. Design Details
  6. Drawbacks
  7. Advantages
  8. Open Questions
  9. Future Directions

Summary

Provide an abstract of the change. Describe the intention and expected impact briefly. Keep it to one paragraph for clarity.

Motivation

Explain why this change is needed. Include any relevant research, conversations, or links that support the motivation.

Current Solutions

Describe how the problem is addressed with current solutions. Identify shortcomings or limitations of these solutions.

Design Overview

Summarize the pain points and provide an outline of how the proposal will address them.

Design Details

Provide a detailed description of the proposal. Include examples and explain its impact on users. Address:

  • Usage examples to clarify the feature.
  • How this will benefit users.
  • Potential error messages or warnings if relevant.
  • For technical proposals, focus on what contributors need to know about implementation and impacts.

Technical Details

Dive into the technical specifics:

  • Clarify interactions with existing features.
  • Outline high-level implementation data.
  • Discuss edge cases with examples if applicable.

Drawbacks

Discuss potential reasons against implementing this proposal. Note considerations that could demand a new proposal or adjustment.

Advantages

Detail why this design is optimal. Consider the impact of not proceeding with this proposal.

Open Questions

Outline any aspects that need resolution during the RFC review or implementation. Mention related topics that are out of scope but could be addressed later.

Future Directions

Explore potential future directions for your proposal. Consider how it might evolve and interact within the project. Use this section for ideas outside the current RFC's scope but relevant context.