Skip to content

Commit ec37a94

Browse files
committed
SPEC 13: Recommended targets and naming conventions
1 parent a6b5264 commit ec37a94

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

spec-0013/ecosystem_voting.jpg

274 KB
Loading

spec-0013/index.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: "SPEC 13 — Recommended targets and naming conventions"
3+
number: 13
4+
date: 2024-06-05
5+
author:
6+
- "Pamphile Roy <roy.pamphile@gmail.com>"
7+
- "Matthias Bussonnier <>"
8+
- "Jarrod Millman <millman@berkeley.edu>"
9+
discussion: https://discuss.scientific-python.org/t/spec-13-recommended-targets-and-naming-conventions
10+
endorsed-by:
11+
---
12+
13+
## Description
14+
15+
For consistency and decreased cognitive load across the ecosystem, this SPEC recommends naming conventions around various project aspects--such as project structure, repository layout, folder names, task runner and `pyproject.toml` targets name.
16+
17+
From a cursory survey in the Scientific Python ecosystem, we discover some frustration from contributors and maintainer when moving from one project to another and belive that consistency will make it both easier for existing maintainer to contribute to manz project as well a decreae the confusion of new developers when contributing or creating new proejcts.
18+
19+
## Implementation
20+
21+
We recommend that by default the targets and folder names:
22+
- related to testing be named `tests` (and not `test`)
23+
- related to documentation be named `docs` (and not `doc`)
24+
- both should be lowercase.
25+
26+
It is ok to have the singular aliases, but the plurals should always be the default.
27+
28+
### Examples
29+
30+
pyproj.toml
31+
docs folder
32+
pip install .[]
33+
spin and dev.py
34+
tox
35+
36+
## Notes
37+
38+
![Vote from ecosystem maintainers at the 2024 Scientific Python Ecosystem Summit in Seattle](./ecosystem_voting.jpg)

0 commit comments

Comments
 (0)