Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PLIP 1: PLIP Purpose and Guidelines #1

Open
wants to merge 8 commits into
base: master
from

Conversation

@karlfloersch
Copy link
Collaborator

karlfloersch commented Jul 8, 2019

This PR adds a proposed PLIP 1. This PLIP is modeled after https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md which defines the much of the foundational structure for future PLIPs.

Figured this would be a good model considering it seems to work for Ethereum. That said, I did make some changes to their wording & so would love feedback.

karlfloersch added 4 commits Jul 8, 2019
@tkmct

This comment has been minimized.

Copy link

tkmct commented Jul 9, 2019

Hi, thank you for great Guideline!!
I have one question for the PLIP types. What does PRC stand for??

@karlfloersch

This comment has been minimized.

Copy link
Collaborator Author

karlfloersch commented Jul 9, 2019

Great question! PRC comes from ERC which stands for "Ethereum Request for Comment." So PRC would be a "Plasma Request for Comment."

It's surprisingly hard to find what "ERC" stands for, but you can see it explained in the Wiki article.

@@ -0,0 +1,218 @@
---
eip: 1

This comment has been minimized.

Copy link
@shogochiai

This comment has been minimized.

Copy link
@karlfloersch

karlfloersch Jul 9, 2019

Author Collaborator

Fixed it :) Thanks for the catch

@tkmct

This comment has been minimized.

Copy link

tkmct commented Jul 9, 2019

Thank you! Now everything make sense!!

PLIPs/plip-1.md Outdated Show resolved Hide resolved
Each PLIP should have the following parts:

- Preamble - RFC 822 style headers containing metadata about the PLIP, including the PLIP number, a short descriptive title (limited to a maximum of 44 characters), and the author details. See [below](#plip-header-preamble) for details.
- Simple Summary - “If you can’t explain it simply, you don’t understand it well enough.” Provide a simplified and layman-accessible explanation of the PLIP.

This comment has been minimized.

Copy link
@gakonst

gakonst Jul 16, 2019

IMO add a "Terminology" section as well. A lot of jargon in our community:) A PLIP that tracks all standardized terminology might be a good idea. Most ppl have no idea what a predicate, an exit game etc. is

- Preamble - RFC 822 style headers containing metadata about the PLIP, including the PLIP number, a short descriptive title (limited to a maximum of 44 characters), and the author details. See [below](#plip-header-preamble) for details.
- Simple Summary - “If you can’t explain it simply, you don’t understand it well enough.” Provide a simplified and layman-accessible explanation of the PLIP.
- Abstract - a short (~200 word) description of the technical issue being addressed.
- Motivation (*optional) - The motivation is critical for PLIPs that want to change the Plasma protocol. It should clearly explain why the existing protocol specification is inadequate to address the problem that the PLIP solves. PLIP submissions without sufficient motivation may be rejected outright.

This comment has been minimized.

Copy link
@gakonst

gakonst Jul 16, 2019

A proposal without motivation seems... weird? Shouldn't be optional imo.

Co-Authored-By: Georgios Konstantopoulos <me@gakonst.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.