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

Create a FIP Editor Handbook for current and intending FIP Editors #1101

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

luckyparadise
Copy link
Collaborator

To further expand the roles, responsibilities, and expectations for FIP Editors. I have written a handbook to form an extended guide for current and intending FIP Editors.
Feedback is welcome.


For pull requests (PRs) that impact **protocol design/specifications** or include **considerations** affecting the protocol:

- FIP Editors must ensure **at least two appropriate technical reviews and approvals** have been obtained before considering the PR ready to merge.
Copy link
Member

Choose a reason for hiding this comment

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

Is the sole difference between these and the ones below the inclusion of "appropriate"? I thought you were going for the "technical".

I'm not sure "appropriate" is well-defined enough for this to make a difference.

- Be interested in participating in governance.
- Be skilled in using GitHub.

Continued inability to meet these requirements may lead to removal from the position. Interested candidates can apply by completing [this form]. Current FIP Editors will review membership requests.
Copy link
Member

Choose a reason for hiding this comment

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

Is there a link to the form someone submits? Are we actually going to make and maintain a form? Given how low volume this will be, is it better to create a mailing list (e.g., [email protected]) that contacts all the FIP editors and they handle from there?

Copy link
Member

Choose a reason for hiding this comment

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

Not even. I think we can just use Slack for this. This document doesn't need to specify a mechanism. If a candidate editor can't figure out how to contact the other editors, they're probably not a fit.

Copy link
Member

@anorth anorth left a comment

Choose a reason for hiding this comment

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

Thanks for starting this, @luckyparadise. I've made some relatively minor suggestions, and it'll be good to have something like this documented.

---

## Introduction
Filecoin Improvement Proposal (FIP) Editors maintain the FIP repository and ensure the editorial completeness of proposals submitted on GitHub. They volunteer their time for the public good, supporting the FIP process by advancing proposals through various stages of their lifecycle. FIP Editors review new proposals, identify formatting and editorial issues, and keep the repository up to date. They leverage their technical expertise to benefit the community by reviewing improvement ideas and providing critical feedback.
Copy link
Member

Choose a reason for hiding this comment

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

I suggest adjusting this to highlight that the technical expertise comes from the community.

Suggested change
Filecoin Improvement Proposal (FIP) Editors maintain the FIP repository and ensure the editorial completeness of proposals submitted on GitHub. They volunteer their time for the public good, supporting the FIP process by advancing proposals through various stages of their lifecycle. FIP Editors review new proposals, identify formatting and editorial issues, and keep the repository up to date. They leverage their technical expertise to benefit the community by reviewing improvement ideas and providing critical feedback.
Filecoin Improvement Proposal (FIP) Editors maintain the FIP repository and ensure the editorial completeness of proposals submitted on GitHub. They volunteer their time for the public good, supporting the FIP process by advancing proposals through various stages of their lifecycle. FIP Editors review new proposals, identify formatting and editorial issues, and keep the repository up to date. They leverage the technical expertise of the community to facilitate the detailed technical, economic, and product review of improvement ideas. FIP Editors may also function as technical reviewers in addition to their facilitation role.


## Membership

Membership is open to all who wish to apply but is subject to consent by existing FIP Editors. This structure ensures scalable and controlled membership over time. As the process gains stability, existing FIP Editors may decide to make membership more open and less controlled.
Copy link
Member

Choose a reason for hiding this comment

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

This would be a change to how we do it now. Membership is currently by invitation and unanimous agreement (or abstention) of the existing editors.

- Be interested in participating in governance.
- Be skilled in using GitHub.

Continued inability to meet these requirements may lead to removal from the position. Interested candidates can apply by completing [this form]. Current FIP Editors will review membership requests.
Copy link
Member

Choose a reason for hiding this comment

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

Not even. I think we can just use Slack for this. This document doesn't need to specify a mechanism. If a candidate editor can't figure out how to contact the other editors, they're probably not a fit.

Comment on lines +64 to +72
Candidates should meet the following criteria:

- Commit **0–5 hours weekly** for reviewing FIPs.
- Be proficient in English (both written and spoken).
- Be capable of critiquing proposal concepts.
- Be familiar with the **Filecoin tech stack**.
- Have **participated in FIP discussions** (an added advantage).
- Be interested in participating in governance.
- Be skilled in using GitHub.
Copy link
Member

Choose a reason for hiding this comment

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

I suggest updating this to be more along the lines of if you would like to be invited to become a FIP editor than you should demonstrate these behaviours.

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.

5 participants