Commit 9f3f22d7 authored by Gampe Sebastian's avatar Gampe Sebastian
Browse files

initial upload of fip system

parents
Welcome to the FIPS repository where community members can propose changes to the FairCoin EcoSystem.
## Contributing
The FIP is based on the Lisk's [LIP](https://github.com/LiskHQ/lips) system but smarter and adjusted to the needs of the FairCoin EcoSystem.
Before contributing please read carefully the following [guidelines](proposals/fip-0001.md).
If you have any questions on how to proceed with a new or existing proposal, please contact the FIPs Admins at [t.me/joinchat/BPPPUVMFBKoHG_sjbsh55w](https://t.me/joinchat/BPPPUVMFBKoHG_sjbsh55w).
## Proposals
| Number | Title | Author | Type | Status |
| ------------------------------|------------------------------------------------------------------------- | -------------------------------------------- | ----------------|----------------------|---------------|
| [0001](proposals/fip-0001.md) | FIP purpose and guidelines | FairCoin | Process | Draft |
```
FIP: 0001
Title: FIP purpose and guidelines
Author: FairCoin
Status: Draft
Type: Organization
Created: 2019-03-12
Updated: 2019-03-12
```
## Abstract
A FairCoin Improvement Proposal (FIP) is a systematically documentation of proposals that want improve the FairCoin EcoSystem.
Every FIP author should discuss the proposal before add it to the list.
It is recommend to find consensus inside the community but not mandatory in all cases.
## Copyright
This FIP is licensed under the [GNU General Public License, version 3][gpl-3].
## Proposal Workflow
![workflow](fip-0001/workflow.png)
#### Create a draft and discuss
At first every proposal starts with a draft that will created by the author in a custom format ( pad, markdown document, pdf, ... ).
English language is not mandatory. Proposals can written in the author's native language.
Make it public in the community and discuss it. If it is not written in english then it is recommend to use translators or translate it to english too.
#### Get feedback and improve it
Get feedback from the community and improve your proposal.
#### Create FIP document
filename: fip-xxxx.md ( structure und format see below this document )
#### Send it to FIPs Admin to check
Contact a FIPs admin that can add your proposal to the list.
Every FIP will checked by the FIPs admin ( language, grammar, understandable, format and structure ok, ...)
#### Find supporters
Every proposal should be a significant number of members ( a dozen ) that want support the proposal.
#### Initialize project
It is recommend to manage the project systematically.
* Who are the developers / makers and how I to get in contact ( nicknames, link to telegram group, ... )
* Timeline, Milestones
* Workspace, documentation of the progress ( can be a git, wiki, shared document, ... )
If the proposal is technical based then it is recommend to create a git repository for the proposal and manage the issues there.
#### Update FIP status
If the project is Initialized successfully then let change the status of FIP from Draft to Active.
If an Active project wants to be rejected by the project members then set the status from Active to Rejected.
If an Active project is not Active anymore and paused or stopped then the status can changed from Active to Inactive.
If an Active project is done or wants to be replaced by another proposal then the Project changes from Active to Final ( and from Final to Replaced. )
## 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.
Each FIP should have the following parts:
* Preamble—Headers containing metadata about the FIP.
* 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].
* Specification—The technical specification should describe the syntax and semantics of any new feature.
* Motivation—Why we should work on this proposal? Which aspect could be improved by this proposal?
* 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.
<mxfile modified="2019-03-13T09:29:37.194Z" host="www.draw.io" agent="Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:65.0) Gecko/20100101 Firefox/65.0" etag="7rbqkzb0Adz909JK9a7d" version="10.4.4" type="device"><diagram id="p1laLvieJJGd11ATvFT_" name="Page-1">7Vtbc5s4FP41nuk+JAPiYvsxcZI2O9uddL2dto8KyKAES0SI2Oyvr8TFgIUdJoktMut0pkEHXc93viPpHDKyZsv1Zwbj8Cv1UTQChr8eWVcjAEzDGotfUpIVEntaCgKG/bJSLZjj/1DVspSm2EdJqyKnNOI4bgs9SgjyeEsGGaOrdrUFjdqjxjBAimDuwUiV/sA+DwvpBIxr+ReEg7Aa2XSnxZslrCqXK0lC6NNVQ2Rdj6wZo5QXT8v1DEVSeZVeinY3O95uJsYQ4X0aEJLdxZP596f1n2dzzLOn58g9A+XceFYtGPli/WWRMh7SgBIYXdfSS0ZT4iPZqyFKdZ2/KI2F0BTCB8R5VoIJU06FKOTLqHyL1pj/lM3PnbL0q/Hmal32nBeyqkA4yxqNZPFX813dLC9V7Yr1yUXtVFspSmjKvLJW/M11bGpb64d1CK5+fvt7vPp+VpkfZAHie+pZG3AFKxBdIjEf0Y6hCHL83J4HLM0z2NSrERQPJYjdgO6b5DOM0nKkGUOQIyG7YnDBFbzbaK5CzNE8hrkiVoLSbeR2Ku8ZMY7WDZG6/vLtpKRDVvG8LK9qdoFKFjaYZRtv11gnBawTBXpTwOpJAVsnBSyFAvNQrFUORXzJA5x4aZIMjgmubibYJyb0ZoLdkwnmsXaDTkTNiVZIG4DW8L4EaQvQGt8dkCac0Uc0oxFl+fosI//RA7bWnd9W3N7tMmZUDDswR7c5EWtzdNXl4uTpehj/pKfxT3Ua/0Qx/hucb/bzNI4FVogNbr+3te/3pqno5ESDvebdgwZgopMHU3UTIJhjGEk0gHHH6IOMkgyMCo72HcE5MaF/HKTvLdDUeg001XvgJhRyc3sn/veply7l8t9EhwWOosb5cza7ET+HOThNdNPEPdGkP016XxEdrTRR7w0j4EZiwpc+fhaPgXwsCLPCeX9eiLxHJE9X99mGTBf+EpOq5T2rGlYSMbdGdx0jfJI6RfmZrehQmMFW38Yfu3r7GPy1bFMzf8c6+Ws22Gucg9fFA8BLAYH3ZLDTl8HukRjcCer05JTfH1Ktp/hqls3rbO4IR9bF6F0SOcdzerb2BM+AYqDjnk7PbDu98TGdnvsxji3ufoqgBWJMnlEGyhILDI0m5ikR2p8loG9U1AI6jwZAa6DbfJXve2sC6DL/pwlucKwoeDfcWgO6xznfa8O722m+Fe+86QVjMGtUiCkmPGn0fCcF9eYBplvx0+nWp18v1XeNLVsrZlBb3mYpr9+hQUdOprFDX3i5foa6P29HqI8ZetvjWXaq8x8kA/sf6MDj6j/waP3epe0tP/DeWJxw+hyF9H4VBvby5wYLEAdLni1v5Nq6vZGlRo3b3iiOhJo+kDdytHsjRaFVsDs0q0D3HaMxTaSdGj8oe1xEdNWIiNf1FLULrfC2btuugVCCthReihKBDiaBEDh16d/c18nbRTeGVACRT866CrHvI6I4zh14daC6E0JTCTQpCFrHRVANSWwgtLczH0KTpIWR+5TSPHUCvccgV9aZV0AhCcWC+0/AsCXBgJidARynfrbyxEjZvp2xqVKcScNOiqGV9Iw6x46EzcGn/TVN5MF1kUaRsEY5VIw8vMCeePSYMDWGBXCyjz2Zph0r3J+AOtoS80wXZ6nHU/lVsqy4oGwJefG8LDRwL/PUedYLkSDCSThq57+GvcbBwMMZJEnpVJRZXqZS0zyUqo5r34p5gqLFqPpefPO++HSmAojQtqFCkjVt9PygRvpygvV/sANsb+LimqZsAea0YwswnUPtAQDovFO8S7Lh2JeKPXGVIX1ut3eaO47BtwQePMrxrgxyDngMFsX6jx2LIFP9J6PW9W8=</diagram></mxfile>
\ No newline at end of file
```
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: <Blockchain | Application | Organization | Exchange>
Status: <Draft | Deferred | Active | Inactive | Rejected | Final | Replaced>
Created: <YYYY-MM-DD>
Updated: <YYYY-MM-DD>
? Requires: <FIP number(s)>
? Replaces: <FIP number>
? Superseded-By: <FIP number>
```
? = optional
## Abstract
Describe in brief what this proposal achieves and how.
## Copyright
This FIP is licensed under the [GNU General Public License, version 3](http://www.gnu.org/licenses/gpl-3.0.html).
## Motivation
Describe the motivations for this proposal.
## Rationale
Describe the reasoning behind this proposal.
## Specification
Describe in detail how this proposal can be achieved.
## Backwards Compatibility
Describe any incompatibilities with the existing protocol, including their severity and how they can be dealt with.
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