From 57813d8aacd34dd44247d495781efcd44d44f795 Mon Sep 17 00:00:00 2001 From: Jarrod Millman Date: Mon, 8 Mar 2021 17:02:42 -0800 Subject: [PATCH] Incorporate feedback from Dan --- core-projects/_index.md | 2 +- purpose-and-process/index.md | 59 ++++++++++++++++++++---------------- steering-committee/_index.md | 14 +++++---- 3 files changed, 42 insertions(+), 33 deletions(-) diff --git a/core-projects/_index.md b/core-projects/_index.md index bb4700c7..8fcaebd0 100644 --- a/core-projects/_index.md +++ b/core-projects/_index.md @@ -99,7 +99,7 @@ To create your project registration file, change into the The script will ask you a few questions and then create a new file appropriately named with a basic template for you to check and complete. -## How do you remove a member? +## How do you remove a project? If a Core Project no longer wishes to participate or if the Steering Committee decides to remove a Core Project, then the project registration file should be deleted, the project diff --git a/purpose-and-process/index.md b/purpose-and-process/index.md index ae0ebd72..6a47ba63 100644 --- a/purpose-and-process/index.md +++ b/purpose-and-process/index.md @@ -87,30 +87,12 @@ existing comments. # Implementation -SPEC Proposals often will be driven by contributors and maintainers of Core or other ecosystem projects. -Only the Steering Committee can accept them (details below). +The Steering Committee manages the SPEC process and will provide guidance to contributors +throughout the process. +In this section, we provide an overview of the main decision points in the SPEC process +and provide guidance for how to get started with a new SPEC proposal. -Before a proposed SPEC can be accepted, the idea must be discussed on the -discussion forum under the [`SPECS/Ideas` topic](https://discuss.scientific-python.org/c/specs/ideas/9). -Thereafter a new SPEC document must be submitted -as a pull request to the [SPEC repository](https://github.com/scientific-python/specs). - -Use the `quickstart.py` script to create a new SPEC document. -Located at the top-level of the -[SPEC repository](https://github.com/scientific-python/specs), -the script will ask you a few questions[^newspec] and then create a new file -appropriately named with a basic template for you to complete. -Once the SPEC is in reasonable shape, file a pull request against the -[SPEC repository](https://github.com/scientific-python/specs). - -A good SPEC proposal focuses on a single key recommendation or idea for -coordinating projects in the scientific Python ecosystem. -Before proposing a SPEC, we highly recommended that you first **vet the idea** -by doing one or more of the following: - -1. discuss the idea with at least one project in the ecosystem, -2. discuss the idea with at least one other member of the ecosystem, or -3. create a minimal, proof of concept prototype. +## Decision Points A SPEC passes through three decision points over the course of its development and implementation: @@ -147,9 +129,8 @@ The **endorse decision** is made by the Core Projects. The Core Projects and interested community members revise the accepted SPEC in a collabortive and iterative process focused on ensuring the SPEC implementation plan that is broadly applicable and likely to be widely adopted. -Often, getting a SPEC endorsed will take longer and be more involved -than having it accepted. -Most SPECs will have several authors from numerous projects including several Core Projects. +The intent is that most SPECs will have several authors from numerous projects +including several Core Projects. A SPEC is recommended for wide-spread adoption once it is endorsed by two (or more) Core Projects. Once a SPEC is recommended, further changes require the approval of all endorsing Core Projects. @@ -168,6 +149,32 @@ Projects that adopt a SPEC early should engage in the collaborative process leading to the SPEC being endorsed by the Core Projects. Each SPEC describes what adopting it means in its _Ecosystem Adoption_ section. +## New SPEC Proposals + +A good SPEC proposal focuses on a single key recommendation or idea for +coordinating projects in the scientific Python ecosystem. +Before proposing a SPEC, we highly recommended that you first **vet the idea** +by doing one or more of the following: + +1. discuss the idea with at least one project in the ecosystem, +2. discuss the idea with at least one other member of the ecosystem, or +3. create a minimal, proof of concept prototype. + +Before a proposed SPEC can be accepted, the idea must be discussed on the +discussion forum under the [`SPECS/Ideas` topic](https://discuss.scientific-python.org/c/specs/ideas/9). +Thereafter a new SPEC document must be submitted +as a pull request to the [SPEC repository](https://github.com/scientific-python/specs). + +Use the `quickstart.py` script to create the new SPEC document. +Located at the top-level of the +[SPEC repository](https://github.com/scientific-python/specs), +the script will ask you a few questions[^newspec] and then create a new file +appropriately named with a basic template for you to complete. +Once the SPEC is in reasonable shape, file a pull request against the +[SPEC repository](https://github.com/scientific-python/specs). +The Steering Committee then considers the SPEC as presented +in the pull request and will provide additional guidance. + # Notes [^newspec]: diff --git a/steering-committee/_index.md b/steering-committee/_index.md index 666bda26..3f5f9abc 100644 --- a/steering-committee/_index.md +++ b/steering-committee/_index.md @@ -27,12 +27,6 @@ In particular, the Steering Committee members - serve as a communication channel to and from projects they contribute to as well as the larger ecosystem. -The Steering Committee decides which SPECs are _accepted_, but not -which SPECs are _adopted_—that choice resides with individual -projects. -Similarly, the Steering Committee does not decide which SPECs are _endorsed_—that -choice resides with individual core projects. - ## Steering Committee {{< page_gallery pages="." >}} @@ -65,6 +59,14 @@ through group consensus and, in the very rare instance where no consensus can be reached, by two-thirds majority vote of those available to cast a vote within ten days. + + ## Who should be a member? Members of the Steering Committee should be active in the scientific Python ecosystem and