Skip to content

Commit

Permalink
Merge pull request #2 from piplabs/ramtin/sip-process-improvements
Browse files Browse the repository at this point in the history
Improvements to the SIP process
  • Loading branch information
ramtinms authored Jan 17, 2025
2 parents 87618a3 + e63388d commit 25d68a8
Show file tree
Hide file tree
Showing 5 changed files with 69 additions and 10 deletions.
1 change: 0 additions & 1 deletion .github/linter/customRules.ts
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,6 @@ export const metadataStatusIsValid = {
if (!status) return

const validStatus = [
"Idea",
"Draft",
"Review",
"Accepted",
Expand Down
20 changes: 20 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Overview

This document holds the list of contributors.

## Current Contributors

| Contributor Github ID | Affiliation |
| ------------------ | ------------------ |
| [Ramarti](https://github.com/Ramarti) | Story Protocol |
| [LeoHChen](https://github.com/LeoHChen) | Story Protocol |
| [Leeren](https://github.com/leeren) | Story Protocol |
| [Lucas2brh](https://github.com/lucas2brh) | Story Protocol |
| [Stevemilk](https://github.com/stevemilk) | Story Protocol |
| [Ezreal1997](https://github.com/ezreal1997) | Story Protocol |
| [Edisonz0718](https://github.com/edisonz0718) | Story Protocol |
| [Jdubpark](https://github.com/jdubpark) | Story Protocol |
| [0xHansLee](https://github.com/0xHansLee) | Story Protocol |
| [Limengformal](https://github.com/limengformal) | Story Protocol |
| [Kingster-will](https://github.com/kingster-will) | Story Protocol |
| [Ramtinms](https://github.com/ramtinms) | Story Protocol |
14 changes: 14 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Overview

This document holds the list of maintainers.

## Current Maintainers

| Maintainer Github ID | Affiliation |
| ------------------ | ------------------ |
| [Ramarti](https://github.com/Ramarti) | Story Protocol |
| [Ramtinms](https://github.com/ramtinms) | Story Protocol |
| [LeoHChen](https://github.com/LeoHChen) | Story Protocol |
| [Edisonz0718](https://github.com/edisonz0718) | Story Protocol |
| [Kingster-will](https://github.com/kingster-will) | Story Protocol |
| [Limengformal](https://github.com/limengformal) | Story Protocol |
4 changes: 2 additions & 2 deletions XXXXX-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ status: Draft
supersedes: (optional - fill this in if the SIP supersedes a previous SIP)
superseded-by: (optional - fill this in if the SIP is superseded by a
subsequent SIP)
extends: (optional - fill this in if the SIP extends the design of a previous
SIP)
extends: (optional - fill this in if the SIP extends the design of a
previous SIP)
---

## Summary
Expand Down
40 changes: 33 additions & 7 deletions proposals/00001-sip-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ the core APIs and user interface. For example, a proposal in this category
can discuss changes to the block production details or node level networking
parameters.

- **Ecosystem SIP:**A proposal describing application-level standards,
- **Ecosystem SIP:** A proposal describing application-level standards,
conventions and specifications that may affect applications, tools, and
services built on top of the Story network. These proposals outline
conventions, interfaces, and protocols that ecosystem participants can follow
Expand All @@ -78,6 +78,23 @@ process, including its structure, lifecycle, and guidelines. For example, a
proposal in this category might suggest expanding SIPs into additional
categories.

### Access Control

While this repository is open for everyone to contribute, community members
are granted two levels of access to prevent spam, scams, and unrelated posts.

- `Contributor`: Community members who have reviewed draft ideas in the forum
can receive this role from maintainers, allowing them to create PRs in this
repository. Once this role is gained it stays active for future, unless
with active votes of majority of maintainers

- `Maintainer`: Maintainers are community members who facilitate the process
by reviewing proposal states and guiding them through the pipeline. Any
proposal state change requires a majority vote from maintainers.
Monthly open-to-all meetings are held to review SIPs and allocate roles.
Through majority voting (2/3), maintainers can grant or revoke both contributor
and maintainer roles within the community.

### SIP Lifecycle

Every SIP starts as an Idea and follows the lifecycle as it progresses.
Expand Down Expand Up @@ -123,11 +140,18 @@ flowchart LR
#### Idea

Every SIP begins as an idea shared with the community through [the Story
's community forum](https://forum.story.foundation/). After thorough
discussion and gathering
support, it can be converted
into a SIP draft. Before this conversion, each idea requires at least one
sponsor—a well-known community member with expertise in the subject matter.
's community forum](https://forum.story.foundation/). Please don't
create any pull request at this stage.
After thorough discussion and gathering support, it can be converted
into a SIP pull request in draft. Before this conversion, each idea requires
at least one sponsor. Sponsors can be any well-known community members who
either benefit from the proposal or have deep expertise in the subject matter.

When an idea has received sufficient feedback and is ready to move into a
draft, it can be converted into a SIP draft pull request. Opening up PRs
in this repo requires a "contributor" role. If an author of the proposal
does not already have a contributor role, the maintainers will add one
or more of the proposal's authors to the contributor list.

#### Draft

Expand Down Expand Up @@ -163,7 +187,9 @@ attention. Each accepted proposal must have a tracking issue in the Story
repository. While proposal authors aren't necessary required to implement
their proposals, this is the most effective path to completion—authors
shouldn't assume other project developers will take on the implementation
work.
work. Unless a proposal is in living state, the proposal becomes immutable
and only acceptable additions to the proposal is security considerations
discovered after the fact.

#### Implemented

Expand Down

0 comments on commit 25d68a8

Please sign in to comment.