Skip to content
This repository has been archived by the owner on Jul 6, 2021. It is now read-only.

Commit

Permalink
Tweak RFC template
Browse files Browse the repository at this point in the history
- Change to use yaml frontmatter
- Change template headings to H2
- Add RFC name as H1
  • Loading branch information
jojanaho committed Jul 24, 2020
1 parent 7e7fee3 commit 0b5831b
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 12 deletions.
28 changes: 16 additions & 12 deletions 0000-template.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
- Start Date: (fill me in with today's date, YYYY-MM-DD)
- RFC PR: (leave this empty)
- Foam Issue: (leave this empty)
---
Start Date: (fill me in with today's date, YYYY-MM-DD)
RFC PR: (leave this empty)
Foam Issue: (leave this empty)
---

# Summary
# 0000 Template

## Summary

Brief explanation of the feature, change or process.

# Basic example
## Basic example

If the proposal involves a new or changed API, include a basic code example.

If the proposal involves a new or changed user interface element, include a description, prototype, or mock-up of the change.

Omit this section if it's not applicable.

# Motivation
## Motivation

Why are we doing this? What use cases does it support? What is the expected
outcome?
Expand All @@ -24,15 +28,15 @@ the motivation could be used to develop alternative solutions. In other words,
enumerate the constraints you are trying to solve without coupling them too
closely to the solution you have in mind.

# Detailed design
## Detailed design

This is the bulk of the RFC. Explain the design in enough detail for somebody
familiar with Foam to understand, and for somebody familiar with the
implementation to implement. This should get into specifics and corner-cases,
and include examples of how the feature is used. Any new terminology should be
defined here.

# Drawbacks
## Drawbacks

Why should we *not* do this? Please consider:

Expand All @@ -44,17 +48,17 @@ Why should we *not* do this? Please consider:

There are tradeoffs to choosing any path. Attempt to identify them here.

# Alternatives
## Alternatives

What other designs have been considered? What is the impact of not doing this?

# Adoption strategy
## Adoption strategy

If we implement this proposal, how will existing Foam users adopt it? Is
this a breaking change? Should we coordinate with
other projects or extensions?

# Unresolved questions
## Unresolved questions

Optional, but suggested for first drafts. What parts of the design are still
TBD?
TBD?
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ into Foam.
* Fork the RFC repo http://github.com/foambubble/rfcs
* Copy `0000-template.md` to `docs/0000-my-feature.md` (where
'my-feature' is descriptive. Don't assign an RFC number yet).
* Change the title of the file to match the file name (e.g. `# 0000 Template` to `# 0000 My Feature`).
* Add a Foam-style wiki link to `docs/index.md` and ensure link reference definitions are appropriately generated.
* Fill in the RFC. Put care into the details: **RFCs that do not
present convincing motivation, demonstrate understanding of the
Expand Down

0 comments on commit 0b5831b

Please sign in to comment.