ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-06-10 19:31:46 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merged in release-process-docs (pull request #88)

Browse Source 
Add a page that briefly describes the proposed release process.
This commit is contained in:
Mike Hearn 2016-05-16 15:55:31 +02:00
commit e38b101970
2 changed files with 37 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/source/index.rst
View File

@ -1,26 +1,24 @@
Welcome to the R3 prototyping repository! Welcome to the Corda repository!
========================================= ================================
This documentation describes the first prototype of a possible future R3 shared ledger platform. This documentation describes the prototype of a proposed architecture for distributed ledgers.
The goal of this prototype is to explore fundamentally better designs for transactions, states and smart contract APIs The goal of this prototype is to explore fundamentally better designs for distributed ledgers than what presently exists
than what presently exists on the market, tailor made for the needs of the financial industry. We are attempting to on the market, tailor made for the needs of the financial industry. We are attempting to prove or disprove the
prove or disprove the following hypothesis: following hypothesis:
*The combination of* The combination of
* *An upgraded state transition model*
* *Industry standard, production quality virtual machines and languages*
* *Limited data propagation*
* *Conflict resolution without proof of work or blocks*
*is sufficiently powerful to justify the creation of a new platform implementation.*
* An upgraded state transition model
* Industry standard, production quality virtual machines and languages
* An advanced orchestration framework
* Limited data propagation
* Conflict resolution without proof of work or blocks
is sufficiently powerful to justify the creation of a new platform implementation.
Read on to learn: Read on to learn:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Overview :caption: Overview
@ -46,6 +44,7 @@ Read on to learn:
:maxdepth: 2 :maxdepth: 2
:caption: Appendix :caption: Appendix
release-process
visualiser visualiser
codestyle codestyle
building-the-docs building-the-docs

23
docs/source/release-process.rst Normal file
View File

@ -0,0 +1,23 @@
Release process
===============
Corda is under heavy development. The current release process is therefore geared towards rapid iteration.
Each Corda development release is called a *milestone* and has its own branch in the git repository. Milestones are
temporarily stabilised snapshots of the Corda code which are suitable for developers to experiment with. They may
receive backported bugfixes but once announced a milestone will not have any API or backwards compatibility breaks.
Between milestones backwards compatibility is expected to break. Every new milestone comes with a short announcement
detailing:
* What major improvements have been made.
* How to forward port your code to the new milestone.
* What new documentation has become available.
* Important known issues.
Eventually, Corda will stabilise and release version 1. At that point backwards compatibility will be guaranteed
forever and the software will be considered production ready. Until then, expect it to be a building site and wear your
hard hat.
Our goal is to cut a new milestone roughly once a month. There are no fixed dates. If need be, a milestone may slip by
a few days to ensure the code is sufficiently usable.