mirror of
https://github.com/tendermint/tendermint.git
synced 2026-01-06 21:36:26 +00:00
This PR is to create signed commits to be able to merge (#50)
Signed-off-by: Marko Baricevic <marbar3778@yahoo.com>
This commit is contained in:
@@ -1,7 +1,5 @@
|
||||
# Tendermint Spec
|
||||
|
||||
This repository contains the paper describing the Tendermint consensus
|
||||
algorithm, including formal proofs of its safety and liveness.
|
||||
This repository contains specs of the current and future implementation of Tendermint the protocol, papers that have been published by the ICF or AIB and ongoing research in a variety of areas.
|
||||
|
||||
For the pdf, see the [latest
|
||||
release](https://github.com/tendermint/spec/releases).
|
||||
- For the pdf, see the [latest release](https://github.com/tendermint/spec/releases).
|
||||
|
||||
5
papers/README.md
Normal file
5
papers/README.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Papers
|
||||
|
||||
This folder houses Papers that have either been published or are a work in progress.
|
||||
|
||||
## Table of Contents
|
||||
5
research/README.md
Normal file
5
research/README.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Research
|
||||
|
||||
This folder holds ongoing research and topics of interest. The [Interchain Foundation](https://interchain.io) has research topics that they are willing fund the research for, to find out more you can go to there [funding repo](https://github.com/interchainio/funding/blob/master/research.md).
|
||||
|
||||
You can apply for a research grant [here](https://docs.google.com/forms/d/e/1FAIpQLSclH4R5G7WgNpKPvXxPPFRA7rAoyX8nNvsJAQJpZNZwWWjFmA/viewform)
|
||||
23
rfc/README.md
Normal file
23
rfc/README.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Request for Comments (RFC)
|
||||
|
||||
RFC stands for `Request for Comments`. It is a social device use to float and polish an idea prior to the inclusion into an existing or new spec/paper/research topic.
|
||||
|
||||
An RFC should not be used for bug reports or trivial discussions - the overhead of compiling an RFC does not justify it.
|
||||
|
||||
An RFC should not consist only of a problem statement (use a standard issue for that).
|
||||
|
||||
A RFC should consist of:
|
||||
|
||||
- Changelog
|
||||
- Context on the relevant goals and the current state
|
||||
- Proposed Solution
|
||||
- Summary of pros and cons
|
||||
- References
|
||||
|
||||
If recorded decisions turned out to be lacking, convene a discussion, record the new decisions here, and then modify the code to match.
|
||||
|
||||
**Note the context/background should be written in the present tense.**
|
||||
|
||||
Some RFC's will be presented at a Tendermint Dev Session. If you are an outside contributor and have submitted a RFC, you may be invited to present your RFC at one of these calls.
|
||||
|
||||
## Table of Contents
|
||||
39
rfc/rfc_template.md
Normal file
39
rfc/rfc_template.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# RFC {RFC-NUMBER}: {TITLE}
|
||||
|
||||
## Changelog
|
||||
|
||||
- {date}: {changelog}
|
||||
|
||||
## Author(s)
|
||||
|
||||
- {First Name} {github handle}
|
||||
|
||||
## Context
|
||||
|
||||
> This section contains all the context one needs to understand the current state, and why there is a problem. It should be as succinct as possible and introduce the high level idea behind the solution.
|
||||
|
||||
## Proposal
|
||||
|
||||
> It should contain a detailed breakdown of how the problem should be resolved including diagrams and other supporting materials needed to present the case and implementation roadmap for the proposed changes. The reader should be able to fully understand the proposal. This section should be broken up using ## subsections as needed.
|
||||
|
||||
## Status
|
||||
|
||||
> A decision may be "proposed" if it hasn't been agreed upon yet, or "accepted" once it is agreed upon. If a later RFC changes or reverses a decision, it may be marked as "deprecated" or "superseded" with a reference to its replacement.
|
||||
|
||||
{Deprecated|Proposed|Accepted}
|
||||
|
||||
## Consequences
|
||||
|
||||
> This section describes the consequences, after applying the decision. All consequences should be summarized here, not just the "positive" ones.
|
||||
|
||||
### Positive
|
||||
|
||||
### Negative
|
||||
|
||||
### Neutral
|
||||
|
||||
## References
|
||||
|
||||
> Are there any relevant PR comments, issues that led up to this, or articles referenced for why we made the given design choice? If so link them here!
|
||||
|
||||
- {reference link}
|
||||
5
spec/README.md
Normal file
5
spec/README.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Spec
|
||||
|
||||
This folder houses the spec of Tendermint the Protocol.
|
||||
|
||||
**Note: We are currently working on expanding the spec and will slowly be migrating it from Tendermint the repo**
|
||||
Reference in New Issue
Block a user