You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: purpose-and-process/_index.md
+44-18Lines changed: 44 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,6 +38,31 @@ several projects—and their authority stems from the extent to which they are.
38
38
Participants in the SPEC process must adhere to our
39
39
[Code of Conduct](https://scientific-python.org/code_of_conduct/).
40
40
41
+
## What is a SPEC?
42
+
43
+
A SPEC (Scientific Python Ecosystem Coordination) is a document that captures an idea.
44
+
A SPEC is the product of discussions with developers across the ecosystem.
45
+
SPECs capture the following types of narratives:
46
+
47
+
- We recommend that you do X (e.g., [SPEC 8 — Securing the Release Process](https://scientific-python.org/specs/spec-0008/)).
48
+
- Some projects may need to do X. If you do X, we recommend that you do it as follows (e.g., [SPEC 1 — Lazy Loading](https://scientific-python.org/specs/spec-0001/)).
49
+
- If you do X, you should be aware of the following (we don't have any such advisories yet).
50
+
51
+
{{< admonition important >}}
52
+
**What a SPEC is not**
53
+
54
+
SPECs are _not_ meant to be extensive technical documents that capture a large amount of detail.
55
+
SPECs typically _summarize_ an idea, referring to external sources for further detail.
56
+
These external resources may be GitHub repositories, external websites, etc.
57
+
58
+
If you find yourself wanting to _disseminate information_ across the
59
+
ecosystem, it may be better to write a blog post on
60
+
https://blog.scientific-python.org or to contribute to an existing
61
+
piece of documentation, such as https://learn.scientific-python.org.
62
+
A blog post is also a good mechanism to get initial engagement around
63
+
an idea that is not mature enough, or in scope, to become a SPEC.
0 commit comments