Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
53 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
This file should remain empty, do not delete it. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
||
|