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

LIP 22 - Refine LIP Creation Process #50

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

defispartan
Copy link

@defispartan defispartan commented Mar 28, 2024

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 members 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.

CreateLIP.mp4

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.

Copy link

height bot commented Mar 28, 2024

Link Height tasks by mentioning a task ID in the pull request title or commit messages, or description and comments with the keyword link (e.g. "Link T-123").

💡Tip: You can also use "Close T-X" to automatically close a task when the pull request is merged.

@alexpoon
Copy link

I recently suggested a migration to CharmVerse for the same reasons. #37

Though even if we want to keep LIPs in Github, the "Discussion" suggested in this LIP can be implemented in a more user friendly discussion on https://tiny.charmverse.io/forum where user's Lens Profile can be used as the primary identity.

@iPaulPro
Copy link

I recently suggested a migration to CharmVerse for the same reasons. #37

Though even if we want to keep LIPs in Github, the "Discussion" suggested in this LIP can be implemented in a more user friendly discussion on https://tiny.charmverse.io/forum where user's Lens Profile can be used as the primary identity.

Using GitHub Discussions helps to keep the entire process in one place, allows for meaningful connections between Discussions and Issues/PRs, and relies on a well established platform that has near-zero risk of shutting down unexpectedly.

Is CharmVerse open source? Can it be self-hosted? If not the risk is probably too large.

I strongly favor using Discussions over a third party platform. I'd like to suggest that Discussions should be where most consumer-level LIPs begin, but that technical LIPs may skip the Discussion step provided that a full technical specification is included with the PR.

@alexpoon
Copy link

alexpoon commented Mar 29, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants