Skip to content

Commit 5dac76f

Browse files
committed
Add SPEC badge recommendation
1 parent 0c47dc6 commit 5dac76f

File tree

2 files changed

+94
-0
lines changed

2 files changed

+94
-0
lines changed

purpose-and-process/_index.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,68 @@ Projects that adopt a SPEC early should engage in the collaborative process
148148
leading to the SPEC being endorsed by the Core Projects.
149149
Each SPEC describes what adopting it means in its _Ecosystem Adoption_ section.
150150

151+
#### Badges
152+
153+
Projects can highlight their adoption of specific SPECs with a SPEC badge.
154+
For example, for SPEC 0, we recommend using
155+
156+
{{< tabs >}}
157+
158+
{{< tab "Rendered badge" >}}
159+
[![SPEC 0 — Minimum Supported Dependencies](https://img.shields.io/badge/SPEC-0-blue)](https://scientific-python.org/specs/spec-0000/)
160+
{{< /tab >}}
161+
162+
{{< tab "Markdown" >}}
163+
164+
```
165+
[![SPEC 0 — Minimum Supported Dependencies](https://img.shields.io/badge/SPEC-0-blue)](https://scientific-python.org/specs/spec-0000/)
166+
```
167+
168+
{{< /tab >}}
169+
170+
{{< tab "reStructuredText" >}}
171+
172+
```
173+
|SPEC 0 — Minimum Supported Dependencies|
174+
175+
.. |SPEC 0 — Minimum Supported Dependencies| image:: https://img.shields.io/badge/SPEC-0-blue
176+
:target: https://scientific-python.org/specs/spec-0000/
177+
```
178+
179+
{{< /tab >}}
180+
181+
{{< /tabs >}}
182+
183+
Alternatively, you can use one badge to indicate adoption of multiple SPECS.
184+
For example, to indicate adoption of SPECs 0, 1, and 4, we recommend the following
185+
186+
{{< tabs >}}
187+
188+
{{< tab "Rendered badge" >}}
189+
[![Scientific Python Ecosystem Coordination](https://img.shields.io/badge/SPEC-0,1,4-blue)](https://scientific-python.org/specs/)
190+
{{< /tab >}}
191+
192+
{{< tab "Markdown" >}}
193+
194+
```
195+
[![Scientific Python Ecosystem Coordination](https://img.shields.io/badge/SPEC-0,1,4-blue)](https://scientific-python.org/specs/)
196+
```
197+
198+
{{< /tab >}}
199+
200+
{{< tab "reStructuredText" >}}
201+
202+
```
203+
|Scientific Python Ecosystem Coordination|
204+
205+
.. |Scientific Python Ecosystem Coordination| image:: https://img.shields.io/badge/SPEC-0,1,4-blue
206+
:target: https://scientific-python.org/specs/
207+
```
208+
209+
{{< /tab >}}
210+
211+
{{< /tabs >}}
212+
151213
### New SPEC Proposals
152214

153215
A good SPEC proposal focuses on a single key recommendation or idea for

quickstart.py

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,38 @@
4848
Briefly discuss what it means for a project to adopt this SPEC.
4949
-->
5050
51+
#### Badges
52+
53+
Projects can highlight their adoption of this SPECs by including a SPEC badge.
54+
55+
{{{{< tabs >}}}}
56+
57+
{{{{< tab "Rendered badge" >}}}}
58+
[![SPEC {number}{title}](https://img.shields.io/badge/SPEC-{number}-blue)](https://scientific-python.org/specs/spec-{number:04d}/)
59+
{{{{< /tab >}}}}
60+
61+
{{{{< tab "Markdown" >}}}}
62+
63+
```
64+
[![SPEC {number}{title}](https://img.shields.io/badge/SPEC-{number}-blue)](https://scientific-python.org/specs/spec-{number:04d}/)
65+
```
66+
67+
{{{{< /tab >}}}}
68+
69+
{{{{< tab "reStructuredText" >}}}}
70+
71+
```
72+
|SPEC {number}{title}|
73+
.. |SPEC {number}{title}| image:: https://img.shields.io/badge/SPEC-{number}-blue
74+
:target: https://scientific-python.org/specs/spec-{number:04d}/
75+
```
76+
77+
{{{{< /tab >}}}}
78+
79+
{{{{< /tabs >}}}}
80+
81+
To indicate adoption of multiple SPECS with one badge, see [this](../purpose-and-process/#badges).
82+
5183
## Implementation
5284
5385
<!--

0 commit comments

Comments
 (0)