From 48114e1208a484a0d2e340a5c1c590bfb77c5e0e Mon Sep 17 00:00:00 2001 From: aschmidt20 Date: Thu, 28 Mar 2024 00:43:29 -0500 Subject: [PATCH 1/2] feat: lip-22 refine LIP creation process --- LIPs/lip-22.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 LIPs/lip-22.md diff --git a/LIPs/lip-22.md b/LIPs/lip-22.md new file mode 100644 index 0000000..96d79dc --- /dev/null +++ b/LIPs/lip-22.md @@ -0,0 +1,34 @@ +--- +title: +description: +author: <@lens/defispartan> +status: Draft +type: +created: +--- + +## Abstract + +There is a currently a high technical barrier of entry to publish an LIP. There is also uncertainty for LIP creators about what level of detail a proposal requires. This proposal seeks to address both of these issues by introducing an optional first stage in the LIP process: "Discussions". By using GitHub Discussions as the first step in the proposal process, this will allow community to more easily begin a proposal conversation and refine ideas before submitting an official LIP pull request. + +## Motivation + +The current process for submitting an LIP is: fork LIP repo -> add LIP file to fork repo -> commit -> open pull request to LIP repo. + +This process can be confusing, especially for people without previous GitHub experience. The LIP process is intended to be a platform for any Lens user to propose changes, so the process of starting a discussion should accommodate for this. + +The current process also has uncertainty about the requirements for creating and refining an LIP. An LIP creator is expected to include all proposal details, but often times the details aren't initially known (technical, procedural), or there is community feedback that makes it unclear whether a proposal should proceed or be modified. Adding a discussion phase would address these uncertainties by lowering the requirements to propose an idea, and allow community feedback before an idea is officially proposed. + +## Specification & Rationale + +I propose that https://github.com/lens-protocol/LIPs/discussions is adopted as an optional first phase in the LIP process, under a new category ("LIP Ideas"). + +This would allow anyone to introduce a new proposal idea in just a few clicks: New discussion -> LIP Ideas - Get Started -> Add title and body -> Start discussion. + +This does not introduce a timeline or conditions for when a proposal should move from the discussion phase to pull request. This is left up to the creator or anyone participating in the thread who wants to create a formal LIP based on the discussion. If a proposal is already well-defined, it could even skip the discussion phase and move directly to LIP. + +This proposal also updates the README to include instructions for creating an "LIP Idea" and "LIP Pull Request". + +## Copyright + +Copyright and related rights waived via CC0. From 356a894a84aff27ad0ab237c9a38ad14f4f3b380 Mon Sep 17 00:00:00 2001 From: aschmidt20 Date: Thu, 28 Mar 2024 00:44:13 -0500 Subject: [PATCH 2/2] feat: add idea and pr instructions to README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index dcb63e2..342c8d9 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,10 @@ We have different types of proposals which currently are: All of these can go through an LIP process. Lens Open Algorithm Standards are the only ones that are not required to go through the LIP process as has its own flow. That said if you want to improve that standards an LIP can be opened for it. +To open a new proposal idea: navigate to the "Discussions" tab -> create a new discussion under the "LIP Ideas" category. + +To submit a refined proposal for community review: fork this repository -> add a new file to the LIPs directory following the LIP template (`LIPs/lip-template.md`) -> commit this new file to the fork repository -> open a pull request back to this repository. + ## Supported standards You can see all the supported standards which that are supported and shaped by LIPs [here](./supported-standards/README.md).