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

Improvements to the SIP process #2

Merged
merged 9 commits into from
Jan 17, 2025
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
11 changes: 11 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Overview

This document holds the list of contributors.

## Current Contributors

| Contributor Github ID | Affiliation |
| ------------------ | ------------------ |
| [Ramarti](https://github.com/Ramarti) | Story Protocol |
| [Ramtinms](https://github.com/ramtinms) | Story Protocol |
| [LeoHChen](https://github.com/LeoHChen) | Story Protocol |
11 changes: 11 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# 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 |
Copy link
Contributor

Choose a reason for hiding this comment

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

please add Ze, Meng, Kingter to maintainers list.

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
38 changes: 32 additions & 6 deletions proposals/00001-sip-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 are well-known community members who either
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there a public list of sponsors? Or is this a fuzzy term by design?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I kept it open for now, as time goes and more people contribute, we might just change into contributors and maintainers. I'll clarify it in the doc.

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
Loading