From 5158820aedb9d7e22e03f9187caa53e7bf0fe2e9 Mon Sep 17 00:00:00 2001 From: Lucky Nwachukwu <113045709+luckyparadise@users.noreply.github.com> Date: Tue, 14 Jan 2025 09:36:32 -0500 Subject: [PATCH 1/3] Create README --- FIP Editor Handbook/README | 86 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 FIP Editor Handbook/README diff --git a/FIP Editor Handbook/README b/FIP Editor Handbook/README new file mode 100644 index 00000000..1f1803ef --- /dev/null +++ b/FIP Editor Handbook/README @@ -0,0 +1,86 @@ +# FIP Editor Handbook + +## README +This document serves as an extended guide on the roles, responsibilities, and expectations of FIP Editors. It builds upon the foundational description provided in **FIP-0001**, which introduced the FIP process and outlined the role of FIP Editors. While FIP-0001 offered an initial framework, this handbook provides more comprehensive guidance to ensure consistency, accountability, and clarity for FIP Editors and the community they serve. + +For detailed information on the FIP process and the foundational principles, refer to **FIP-0001** in the [Filecoin FIP repository](https://github.com/filecoin-project/FIPs). + +--- + +## 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. + +--- + +## Mission +FIP Editors aim to facilitate the structured advancement of the Filecoin protocol by managing and refining FIP submissions. Their mission is to uphold the standards set by the community and ensure that each proposal receives a fair and thorough evaluation. + +--- + +## Responsibilities +FIP Editors serve the community by: + +- **Editorial Review**: Ensuring proposals are well-formatted, technically complete, and adhere to Filecoin protocol standards. +- **Facilitating Discussion**: Encouraging open dialogue and collaboration within the community to refine and enhance proposals. +- **Upholding Quality**: Maintaining a standard of quality for proposals, focusing on the needs of their target audience. +- **Repository Maintenance**: Managing version control and processing pull requests and FIPs in the GitHub repository promptly. +- **Governance Support**: Identifying when proposals are ready to advance to the "Last Call" stage. +- **Ensuring Review Standards**: Verifying that pull requests meet review standards before merging, as outlined below. + +--- + +## Limitations +FIP Editors do not: + +- **Pass Judgments**: They do not serve as arbiters of the merit of proposals or determine their likelihood of acceptance. +- **Assert Correctness**: While they may offer technical feedback, they do not confirm the technical soundness of proposals. +- **Decide Network Upgrades**: They do not determine which FIPs should be included in network upgrades, even though some FIP Editors may be involved in implementation teams. + +--- + +## Pull Request Review Standards + +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. + +For **all other PRs**: + +- A minimum of **two technical reviews and approvals** is required before merging. + +### Additional Safeguards + +To ensure sufficient review time and prevent rushed decisions: + +- FIP Editors should allow a reasonable review period (e.g., 48–72 hours) after obtaining the required two approvals before merging the PR, unless the changes are time-sensitive and have explicit consensus from other editors. +- Editors should use their judgment to balance the urgency of changes with the need for thorough review. + +--- + +## 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. + +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. + +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. + +--- + +## Decision Making + +### Informal Decisions +For non-controversial decisions, particularly those affecting a single proposal, FIP Editors may select the course of action they deem fit, aligned with Filecoin's mission and values. + +### Formal Decisions + +- **Adding a FIP Editor**: Candidates must consent to the responsibilities and be unopposed by current editors. +- **Removing a FIP Editor**: Voluntary resignation is preferred; however, involuntary removal follows documented failures and a chance for correction. A consensus among remaining editors, excluding the affected editor, is required to finalize removal, ensuring fairness and integrity in the process. From 713af23e90ab89096fdb9f34f41df40572c13fa6 Mon Sep 17 00:00:00 2001 From: Lucky Kelechukwu Nwachukwu <113045709+luckyparadise@users.noreply.github.com> Date: Tue, 21 Jan 2025 19:09:35 +0300 Subject: [PATCH 2/3] Rename README to README.md --- FIP Editor Handbook/{README => README.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename FIP Editor Handbook/{README => README.md} (100%) diff --git a/FIP Editor Handbook/README b/FIP Editor Handbook/README.md similarity index 100% rename from FIP Editor Handbook/README rename to FIP Editor Handbook/README.md From 56ad9eb60742ff1a5ab3e765b935435d6b093ca1 Mon Sep 17 00:00:00 2001 From: Lucky Kelechukwu Nwachukwu <113045709+luckyparadise@users.noreply.github.com> Date: Tue, 21 Jan 2025 19:10:45 +0300 Subject: [PATCH 3/3] Rename README.md to FIPEditorHandBook.md --- FIP Editor Handbook/{README.md => FIPEditorHandBook.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename FIP Editor Handbook/{README.md => FIPEditorHandBook.md} (100%) diff --git a/FIP Editor Handbook/README.md b/FIP Editor Handbook/FIPEditorHandBook.md similarity index 100% rename from FIP Editor Handbook/README.md rename to FIP Editor Handbook/FIPEditorHandBook.md