Skip to content

Commit

Permalink
chore: Update RFC template (vectordotdev#3193)
Browse files Browse the repository at this point in the history
  • Loading branch information
binarylogic authored Jul 28, 2020
1 parent c865446 commit 02b2e6d
Showing 1 changed file with 32 additions and 29 deletions.
61 changes: 32 additions & 29 deletions rfcs/_YYYY-MM-DD-issue#-title.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,58 +2,61 @@

One paragraph description of the change.

## Motivation
## Scope

Context that helps readers understand the motivation behind this change.
- What will this RFC cover, and what will it not cover?
- Link to any previous RFCs for additional context.

## Guide-level Proposal
## Motivation

Describe your proposal in the form of a guide, as if it were being presented
to a Vector user.
- What is the problem?
- What pain motivated this change?
- Do not cover benefits of your change, that should be covered in the "Rationale" section.

1. Be succint and to the point!
2. Use code examples instead of long conceptual explanations!
3. Run your guide through grammarly or a similar tool.
## Internal Proposal

## Doc-level Proposal
- Describe your change as if you were presenting it to the Vector team.
- Use lists, examples, and code blocks for efficient reading.
- Be specific!

If this feature requires documentation or reference changes please include
those here. Please create sections for each new page within our docs.
## Doc-level Proposal

## Prior Art
- Optional. Only do this if your change is public facing.
- Demonstrate how your change will look in the form of Vector's public docs.

List prior art, the good and bad. Why can't we simply use them?
## Rationale

## Sales Pitch
- Why is this change worth it?
- What is the impact of not doing this?
- How does this position us for success in the future?

Sell this change.
## Prior Art

* Why is this design the best in the space of possible designs?
* How will this change make Vector superior?
* What other designs have been considered and what is the rationale for not choosing them?
* What is the impact of not doing this?
- List prior art, the good and bad.
- Why can't we simply use or copy them?

## Drawbacks

Why should we not do this?
- Why should we not do this?
- What kind on ongoing burden does this place on the team?

## Rationale & Alternatives
## Alternatives

* Why is this design the best in the space of possible designs?
* What other designs have been considered and what is the rationale for not choosing them?
* What is the impact of not doing this?
- What other approaches have been considered and why did you not choose them?
- How about not doing this at all?

## Outstanding Questions

List any outstanding questions that we can discuss and resolve.
- List any remaining questions that you have.
- These must be resolved before the RFC can be merged.

## Plan Of Attack

Incremental steps that execute this change. Generally this is in the form of:

* [ ] Submit a PR with spike-level code _roughly_ demonstrating the change.
* [ ] Incremental change #1
* [ ] Incremental change #2
* [ ] ...
- [ ] Submit a PR with spike-level code _roughly_ demonstrating the change.
- [ ] Incremental change #1
- [ ] Incremental change #2
- [ ] ...

Note: This can be filled out during the review process.

0 comments on commit 02b2e6d

Please sign in to comment.