Skip to content

Commit

Permalink
add Template.md
Browse files Browse the repository at this point in the history
  • Loading branch information
narimiran committed Jan 8, 2019
1 parent 720d252 commit 225220a
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
@@ -1,8 +1,11 @@
# RFCs

A repository for your Nim proposals.
A repository for your Nim proposals.

---

This is WIP and it will take days (weeks?) until this is in a representative state.
For now, try to wait with your proposals and RFCs to spare both you and us the additional work later.
## Contributing

1. Fork and clone this repository.
2. Create a new, appropriately named, markdown document in the `RFCs` directory, based on [Template.md](Template.md).
3. Write your RFC, following the guidelines in the template.
4. Submit a pull request containing your new file.
1 change: 1 addition & 0 deletions RFCs/empty.txt
@@ -0,0 +1 @@
This file should remain empty, do not delete it.
45 changes: 45 additions & 0 deletions Template.md
@@ -0,0 +1,45 @@
# {RFC title}


## Abstract

Just a few sentences (less is more) where you describe your idea.


## Motivation

Describe *why* you think this is a good idea.
What problems does it solve?
Who can benefit from it?


## Description

Here you go into more details about your proposal.
This section can be few paragraphs long.

If you have an idea how to implement it, describe the steps needed.

If there were similar similar proposals already or there can be some alternative approaches to this problem, highlight the differences between those and your proposal, stating why your current proposal is superior.

What are the downsides of this proposal?


## Examples

Code examples should be short and informative.
Try to use real-world examples.

### Before
Show (in a code block) the current situation.

### After
Show the same situations if your RFC is accepted.
If necessary, use code comments to pin-point the changes.


## Backward incompatibility

If your RFC introduces backward-incompatible changes, describe them and propose how to deal with them.


0 comments on commit 225220a

Please sign in to comment.