From 81a0198af23e8b64230e8986f5f960a25c3e43d8 Mon Sep 17 00:00:00 2001 From: Marko Date: Sat, 14 Sep 2019 19:56:17 +0200 Subject: [PATCH] This PR is to create signed commits to be able to merge (#50) Signed-off-by: Marko Baricevic --- README.md | 6 +-- papers/README.md | 5 +++ research/README.md | 5 +++ rfc/README.md | 23 +++++++++++ rfc/rfc_template.md | 39 +++++++++++++++++++ spec/README.md | 5 +++ {consensus => spec/consensus}/IEEEtran.bst | 0 {consensus => spec/consensus}/IEEEtran.cls | 0 {consensus => spec/consensus}/README.md | 0 .../consensus}/algorithmicplus.sty | 0 {consensus => spec/consensus}/conclusion.tex | 0 {consensus => spec/consensus}/consensus.tex | 0 {consensus => spec/consensus}/definitions.tex | 0 {consensus => spec/consensus}/homodel.sty | 0 {consensus => spec/consensus}/intro.tex | 0 {consensus => spec/consensus}/latex8.bst | 0 {consensus => spec/consensus}/latex8.sty | 0 {consensus => spec/consensus}/lit.bib | 0 {consensus => spec/consensus}/paper.tex | 0 {consensus => spec/consensus}/proof.tex | 0 {consensus => spec/consensus}/rounddiag.sty | 0 {consensus => spec/consensus}/technote.sty | 0 22 files changed, 79 insertions(+), 4 deletions(-) create mode 100644 papers/README.md create mode 100644 research/README.md create mode 100644 rfc/README.md create mode 100644 rfc/rfc_template.md create mode 100644 spec/README.md rename {consensus => spec/consensus}/IEEEtran.bst (100%) rename {consensus => spec/consensus}/IEEEtran.cls (100%) rename {consensus => spec/consensus}/README.md (100%) rename {consensus => spec/consensus}/algorithmicplus.sty (100%) rename {consensus => spec/consensus}/conclusion.tex (100%) rename {consensus => spec/consensus}/consensus.tex (100%) rename {consensus => spec/consensus}/definitions.tex (100%) rename {consensus => spec/consensus}/homodel.sty (100%) rename {consensus => spec/consensus}/intro.tex (100%) rename {consensus => spec/consensus}/latex8.bst (100%) rename {consensus => spec/consensus}/latex8.sty (100%) rename {consensus => spec/consensus}/lit.bib (100%) rename {consensus => spec/consensus}/paper.tex (100%) rename {consensus => spec/consensus}/proof.tex (100%) rename {consensus => spec/consensus}/rounddiag.sty (100%) rename {consensus => spec/consensus}/technote.sty (100%) diff --git a/README.md b/README.md index 068a3c171..9056750ea 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/papers/README.md b/papers/README.md new file mode 100644 index 000000000..dd8835681 --- /dev/null +++ b/papers/README.md @@ -0,0 +1,5 @@ +# Papers + +This folder houses Papers that have either been published or are a work in progress. + +## Table of Contents diff --git a/research/README.md b/research/README.md new file mode 100644 index 000000000..dcb51a4bc --- /dev/null +++ b/research/README.md @@ -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) diff --git a/rfc/README.md b/rfc/README.md new file mode 100644 index 000000000..9682b9f1a --- /dev/null +++ b/rfc/README.md @@ -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 diff --git a/rfc/rfc_template.md b/rfc/rfc_template.md new file mode 100644 index 000000000..817066ee4 --- /dev/null +++ b/rfc/rfc_template.md @@ -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} diff --git a/spec/README.md b/spec/README.md new file mode 100644 index 000000000..ba881643e --- /dev/null +++ b/spec/README.md @@ -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** diff --git a/consensus/IEEEtran.bst b/spec/consensus/IEEEtran.bst similarity index 100% rename from consensus/IEEEtran.bst rename to spec/consensus/IEEEtran.bst diff --git a/consensus/IEEEtran.cls b/spec/consensus/IEEEtran.cls similarity index 100% rename from consensus/IEEEtran.cls rename to spec/consensus/IEEEtran.cls diff --git a/consensus/README.md b/spec/consensus/README.md similarity index 100% rename from consensus/README.md rename to spec/consensus/README.md diff --git a/consensus/algorithmicplus.sty b/spec/consensus/algorithmicplus.sty similarity index 100% rename from consensus/algorithmicplus.sty rename to spec/consensus/algorithmicplus.sty diff --git a/consensus/conclusion.tex b/spec/consensus/conclusion.tex similarity index 100% rename from consensus/conclusion.tex rename to spec/consensus/conclusion.tex diff --git a/consensus/consensus.tex b/spec/consensus/consensus.tex similarity index 100% rename from consensus/consensus.tex rename to spec/consensus/consensus.tex diff --git a/consensus/definitions.tex b/spec/consensus/definitions.tex similarity index 100% rename from consensus/definitions.tex rename to spec/consensus/definitions.tex diff --git a/consensus/homodel.sty b/spec/consensus/homodel.sty similarity index 100% rename from consensus/homodel.sty rename to spec/consensus/homodel.sty diff --git a/consensus/intro.tex b/spec/consensus/intro.tex similarity index 100% rename from consensus/intro.tex rename to spec/consensus/intro.tex diff --git a/consensus/latex8.bst b/spec/consensus/latex8.bst similarity index 100% rename from consensus/latex8.bst rename to spec/consensus/latex8.bst diff --git a/consensus/latex8.sty b/spec/consensus/latex8.sty similarity index 100% rename from consensus/latex8.sty rename to spec/consensus/latex8.sty diff --git a/consensus/lit.bib b/spec/consensus/lit.bib similarity index 100% rename from consensus/lit.bib rename to spec/consensus/lit.bib diff --git a/consensus/paper.tex b/spec/consensus/paper.tex similarity index 100% rename from consensus/paper.tex rename to spec/consensus/paper.tex diff --git a/consensus/proof.tex b/spec/consensus/proof.tex similarity index 100% rename from consensus/proof.tex rename to spec/consensus/proof.tex diff --git a/consensus/rounddiag.sty b/spec/consensus/rounddiag.sty similarity index 100% rename from consensus/rounddiag.sty rename to spec/consensus/rounddiag.sty diff --git a/consensus/technote.sty b/spec/consensus/technote.sty similarity index 100% rename from consensus/technote.sty rename to spec/consensus/technote.sty