Commit 35eedb59 authored by Gampe Sebastian's avatar Gampe Sebastian
Browse files

update preample info

parent 61d612a3
......@@ -63,7 +63,7 @@ If an Active project is done or wants to be replaced by another proposal then th
## FIP Format and Structure
FIPs should be written in [Markdown][markdown] format. A template FIP is provided [here][fips-template] as the basis for all new proposals.
FIPs should be written in [Markdown](https://guides.github.com/features/mastering-markdown/) format. A template FIP is provided [here](https://git.fairkom.net/FairCoin/fips/blob/master/template.md) as the basis for all new proposals.
Each FIP should have the following parts:
......@@ -71,7 +71,7 @@ Each FIP should have the following parts:
* Abstract—A short (~200 word) description of the technical issue being addressed.
* Copyright—Each FIP must be licensed under the [GNU General Public License, version 3][gpl-3].
* Copyright—Each FIP must be licensed under the [GNU General Public License, version 3](https://www.gnu.org/licenses/gpl-3.0).
* Specification—The technical specification should describe the syntax and semantics of any new feature.
......@@ -80,3 +80,79 @@ Each FIP should have the following parts:
* Rationale—It describes the history of the proposal. What was the starting point, which experiences were made and alternatives tried or discussed.
* Backwards compatibility—All proposals must describe the compatibility to the existing system and if it is not compatible then explain how it could work additionally or by a transition stage.
## LIP Header Preamble
```
FIP: <FIP number>
Title: <FIP title>
Author: <List of authors' names including contact>
? Discussion-To: <Link to chat group or forum where the FIP can be discussed>
? Comments-URI: <Link to user comments ( wiki page, etc. )>
Type: <Core | Distribution>
Module: <Blockchain | Application | Organization | Markets>
Status: <Draft | Deferred | Active | Inactive | Rejected | Final | Replaced>
Created: <YYYY-MM-DD>
Updated: <YYYY-MM-DD>
Scheduled: <YYYY-MM-DD>
? Requires: <FIP number(s)>
? Replaces: <FIP number>
? Superseded-By: <FIP number>
```
Every FIP starts with the preample, see the [template](https://git.fairkom.net/FairCoin/fips/blob/master/template.md)
(?) are optional.
#### FIP
Number of proposal assigned by FIP Admin.
..
#### Type
There are two types of proposals. Core and Distribution.
###### Type : Core
* Proposals that affect the core of the system.
* Changes of the core affects changes to all ( community ).
* Core proposals needs a consensus of the community for Activation !!
###### Type : Distribution
* Proposals that don't affect the core.
* Changes are only changes for a part of the community.
* No community member will forced to use it.
#### Status
The Status of proposal will changed by FIP Admin.
| Deferred | Active | Inactive | Rejected | Final | Replaced
###### Status : Draft
Every proposal starts with the Status Draft until a project to realize the proposal is initialized successfully.
###### Status : Deferred
Any Draft can be Deferred for example if it is waiting for ressources or the completion of other proposals.
###### Status : Active
If a project is successfully initialized.
###### Status : Inactive
If a project is paused or stopped for example if the devs/makers has left the project.
###### Status : Rejected
If during the project the support of the proposal has left then an Active project can be rejected.
###### Status : Replaced
If a project wants to be replaced by another (better) proposal then the Status Replaced can be set.
Notice that in the preample the field "Superseded-By" must contain the new FIP AND in the preample of the new FIP "Replaces" must contain the number of the replaced FIP.
###### Status : Final
If a project is finished and the proposal realized then the Status Final will set.
#### Scheduled
Is the date of completion of the FIP and important for the roadmap of FairCoin EcoSystem.
The Scheduled date should be in tendency conservative because often the scheduled timeline will broken because the things are more complex than expected.
The scheduled date can be changed by FIP Admin.
......@@ -4,7 +4,8 @@ Title: <FIP title>
Author: <List of authors' names including contact>
? Discussion-To: <Link to chat group or forum where the FIP can be discussed>
? Comments-URI: <Link to user comments ( wiki page, etc. )>
Type: <Blockchain | Application | Organization | Exchange>
Type: <Core | Distribution >
Module: <Blockchain | Application | Organization | Markets>
Status: <Draft | Deferred | Active | Inactive | Rejected | Final | Replaced>
Created: <YYYY-MM-DD>
Updated: <YYYY-MM-DD>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment