SPEC 13: Recommended targets and naming conventions #324
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,38 @@ | ||||||
| --- | ||||||
| title: "SPEC 13 — Recommended targets and naming conventions" | ||||||
| number: 13 | ||||||
| date: 2024-06-05 | ||||||
| author: | ||||||
| - "Pamphile Roy <roy.pamphile@gmail.com>" | ||||||
| - "Matthias Bussonnier <>" | ||||||
| - "Jarrod Millman <millman@berkeley.edu>" | ||||||
| discussion: https://discuss.scientific-python.org/t/spec-13-recommended-targets-and-naming-conventions | ||||||
| endorsed-by: | ||||||
| --- | ||||||
|
|
||||||
| ## Description | ||||||
|
|
||||||
| 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. | ||||||
|
There was a problem hiding this comment. I would also add some defaults for declaring optional dependencies: There was a problem hiding this comment. never mind, should have read all the comments below before commenting, as this was already mentioned. There was a problem hiding this comment. test --> tests, bike shedding, but I'm 👎 on this. As it's test-dependencies in my view while the other recommendation is about a directory that contains the tests There was a problem hiding this comment. Just hard to remember that "s" is for testing dir ( There was a problem hiding this comment. astropy does it this way since forever 😄 There was a problem hiding this comment. Not too fond of There was a problem hiding this comment. We also limited the discussion to We can extend to other naming conventions later. |
||||||
|
|
||||||
| 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. | ||||||
tupui marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ## Implementation | ||||||
|
|
||||||
| We recommend that by default the targets and folder names: | ||||||
| - related to testing be named `tests` (and not `test`) | ||||||
| - related to documentation be named `docs` (and not `doc`) | ||||||
| - both should be lowercase. | ||||||
|
|
||||||
| It is ok to have the singular aliases, but the plurals should always be the default. | ||||||
|
|
||||||
| ### Examples | ||||||
|
|
||||||
| pyproj.toml | ||||||
|
There was a problem hiding this comment. There was a problem hiding this comment. ??
Suggested change
|
||||||
| docs folder | ||||||
| pip install .[] | ||||||
| spin and dev.py | ||||||
| tox | ||||||
|
|
||||||
| ## Notes | ||||||
|
|
||||||
|  | ||||||
Uh oh!
There was an error while loading. Please reload this page.