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

docs: CID spec should follow IPIP process #51

Merged
merged 1 commit into from
Aug 2, 2022
Merged

Conversation

lidel
Copy link
Member

@lidel lidel commented Jul 28, 2022

This PR clarifies the CID spec governance by pointing at IPIP process from ipfs/specs repo.

I suggest reusing IPIP because don't have anything better, and something is better than no process at all, but other ideas are welcome.

Rationale

CID specification is extremely important for IPFS ecosystem, and we need a clear policy how spec change proposals (namely, proposing new versions, like #49) should be handled now and in the future.

We need to have a policy for CID and other Mutliformats, but since CID is the only one that has the concept of versions, let's scope this to CID repo for now.

Why IPIP?

The IPIP template provides prompts around key areas that need to be filled, which ensures the bare minimum structure and context that gets everyone up-to-speed, including a summary of relevant prior discussions.

This allows implementers and the wider IPFS community to evaluate, provide more meaningful feedback, and reach a rough consensus around a proposal.

@RangerMauve
Copy link

Clarification from community call today:

  • We'd like to use the IPIP process, but we'd like to keep the spec itself in the usual repo

Copy link
Member

@Stebalien Stebalien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems reasonable.

Copy link

@QUGL-98-06-15 QUGL-98-06-15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link

@QUGL-98-06-15 QUGL-98-06-15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LAQ

@@ -163,6 +163,14 @@ Yes, kind of! like a file extension, the multicodec identifier establishes the f

We are figuring this out at this time. It will likely be a table of formats for secure distributed systems. So far, we want to address: IPFS's original protobuf format, the new IPLD CBOR format, git, bitcoin, and ethereum objects.

> **Q. What is the process for updating CID specification (e.g., adding a new version)?**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Q

Copy link

@QUGL-98-06-15 QUGL-98-06-15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs/cid-spec-governance

Copy link

@QUGL-98-06-15 QUGL-98-06-15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs/cid-spec-governance

Copy link

@QUGL-98-06-15 QUGL-98-06-15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CID

@lidel lidel merged commit 2d38401 into master Aug 2, 2022
@lidel lidel deleted the docs/cid-spec-governance branch August 2, 2022 13:05
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.

6 participants