8000 Restructure SPEC comments (#372) · scientific-python/specs@aa07647 · GitHub
[go: up one dir, main page]

Skip to content

Commit aa07647

Browse files
authored
Restructure SPEC comments (#372)
1 parent 378e815 commit aa07647

File tree

12 files changed

+11
-27
lines changed

12 files changed

+11
-27
lines changed

purpose-and-process/_index.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ reviewing, discussing, implementing, and endorsing SPEC documents.
5454
SPEC Steering Committee
5555
: The [Steering Committee](/specs/steering-committee) leads the SPEC project and
5656
manages the SPEC process including moderating
57-
the [SPECs discussion forum](https://discuss.scientific-python.org/c/specs/6),
57+
the [SPECs discussion forum](https://discuss.scientific-python.org/c/specs/),
5858
accepting SPEC documents, and maintaining the SPEC process documents.
5959

6060
SPEC Process
@@ -79,10 +79,7 @@ The SPEC documents are converted to HTML by code in the
7979
[scientific-python.org repository](https://github.com/scientific-python/scientific-python.org/) using
8080
[Hugo](https://gohugo.io/) and deployed to
8181
[https://scientific-python.org/specs/](https://scientific-python.org/specs/).
82-
Each SPEC has a corresponding
83-
[discussion](https://discuss.scientific-python.org/c/specs/accepted/15)
84-
with the same title, where anyone can comment, ask questions, or vote on
85-
existing comments.
82+
Each SPEC has two corresponding discussions: one under [SPECS → Ideas](https://discuss.scientific-python.org/c/specs/ideas), where the SPEC committee discussed its viability, and another under [SPECS → Web Comments](https://discuss.scientific-python.org/c/specs/web-comments), where public comments from https://scientific-python.org/specs are stored.
8683

8784
## Implementation
8885

@@ -122,9 +119,10 @@ The decision to **accept** a SPEC is made by the Steering Committee,
122119
at which point it is added to the main branch of the [SPEC
123120
repository](https://github.com/scientific-python/specs), clearly
124121
labeled as a draft.
125-
Proposed SPECs are accepted once (a) the draft is written to clearly
126-
explain the area of common concern and a general approach to a shared
127-
solution and (b) there are contributors (from at least two Core
122+
Proposed SPECs are accepted once (a) there is agreement that the SPEC
123+
concept is applicable to the ecosystem, (b) a draft pull request is
124+
written to clearly explain the area of common concern and a general
125+
approach to a shared solution, and (c) there are contributors (from at least two Core
128126
Projects) interested in working on the new SPEC and in championing it
129127
to their projects as well as the larger community.
130128
Additional details may be found in [Steering Committee
@@ -248,11 +246,11 @@ the idea** by doing one or more of the following:
248246
2. discuss the idea with at least one other member of the ecosystem, or
249247
3. create a minimal, proof of concept prototype.
250248

251-
Before a proposed SPEC can be accepted, the idea must be discussed on
252-
the discussion forum under the [`SPECS/Ideas`
253-
topic](https://discuss.scientific-python.org/c/specs/ideas/9).
254-
Thereafter a new SPEC document must be submitted as a pull request to
255-
the [SPEC repository](https://github.com/scientific-python/specs).
249+
Before a proposed SPEC can be accepted:
250+
251+
1. The idea must be proposed on the discussion forum under the [`SPECS/Ideas`
252+
topic](https://discuss.scientific-python.org/c/specs/ideas/9).
253+
2. A draft SPEC document must be submitted via pull request to the [SPEC repository](https://github.com/scientific-python/specs).
256254

257255
Use the `quickstart.py` script to create the new SPEC document.
258256
Located at the top-level of the [SPEC
@@ -262,8 +260,6 @@ appropriately named with a basic template for you to complete (e.g.,
262260
`spec-0000/index.md`).
263261
Once the SPEC is in reasonable shape, file a pull request against the
264262
[SPEC repository](https://github.com/scientific-python/specs).
265-
The Steering Committee then considers the SPEC as presented in the
266-
pull request and will provide additional guidance.
267263

268264
## Notes
269265

quickstart.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
date: {now.strftime("%Y-%m-%d")}
2828
author:
2929
- "{author} <{email}>"
30-
discussion: https://discuss.scientific-python.org/t/
3130
is-draft: true
3231
endorsed-by:
3332
---

spec-0000/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ author:
1313
- "Ross Barnowski <rossbar@berkeley.edu>"
1414
- "Stéfan van der Walt <stefanv@berkeley.edu>"
1515
- "Thomas A Caswell <tcaswell@gmail.com>"
16-
discussion: https://discuss.scientific-python.org/t/spec-0-minimum-supported-versions/33
1716
endorsed-by:
1817
- ipython
1918
- matplotlib

spec-0001/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ author:
77
- "Jon Crall <jon.crall@kitware.com>"
88
- "Dan Schult <dschult@colgate.edu>"
99
- "Jarrod Millman <millman@berkeley.edu>"
10-
discussion: https://discuss.scientific-python.org/t/spec-1-lazy-loading-for-submodules/25
1110
endorsed-by:
1211
- ipython
1312
- networkx

spec-0002/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ date: 2021-12-16
55
author:
66
- "Jarrod Millman <millman@berkeley.edu>"
77
- "Aditi Juneja <aditijuneja7@gmail.com>"
8-
discussion:
98
is-draft: true
109
endorsed-by:
1110
---

spec-0003/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ date: 2022-02-14
55
author:
66
- "Juanita Gomez <juanitagomezr2112@gmail.com>"
77
- "Sarah Kaiser <sckaiser@sckaiser.com>"
8-
discussion: https://discuss.scientific-python.org/t/spec-3-accessibility/63
98
is-draft: true
109
endorsed-by:
1110
---

spec-0004/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ author:
1010
- "Mridul Seth <mail@mriduls.com>"
1111
- "Olivier Grisel <olivier.grisel@ensta.org>"
1212
- "Tim Head <betatim@gmail.com>"
13-
14-
discussion: https://discuss.scientific-python.org/t/spec-4-nightly-wheels/474
1513
endorsed-by:
1614
- ipython
1715
- matplotlib

spec-0005/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ author:
88
- "Ryan May <rmay@ucar.edu>"
99
- "Jarrod Millman <millman@berkeley.edu>"
1010
- "Brigitta Sipőcz <brigitta.sipocz@gmail.com>"
11-
discussion: https://discuss.scientific-python.org/t/spec-5-ci-best-practices/507
1211
is-draft: true
1312
endorsed-by:
1413
---

spec-0006/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ author:
77
- "Jarrod Millman <millman@berkeley.edu>"
88
- "Pamphile Roy <roy.pamphile@gmail.com>"
99
- "Lars Grüter <lagru@mailbox.org>"
10-
discussion: https://discuss.scientific-python.org/t/spec-6-keys-to-the-castle
1110
endorsed-by:
1211
- ipython
1312
- networkx

spec-0007/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ author:
77
- "Sebastian Berg <sebastianb@nvidia.com>"
88
- "Pamphile Roy <roy.pamphile@gmail.com>"
99
- "Matt Haberland <mhaberla@calpoly.edu>"
10-
discussion: https://github.com/scipy/scipy/issues/14322
1110
endorsed-by:
1211
- ipython
1312
- numpy

0 commit comments

Comments
 (0)
0