Skip to content

Commit

Permalink
SPEC 13: Recommended targets and naming conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
tupui committed Jun 5, 2024
1 parent a6b5264 commit ec37a94
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
Binary file added spec-0013/ecosystem_voting.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions spec-0013/index.md
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 <[email protected]>"
- "Matthias Bussonnier <>"
- "Jarrod Millman <[email protected]>"
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.

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.

## 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
docs folder
pip install .[]
spin and dev.py
tox

## Notes

![Vote from ecosystem maintainers at the 2024 Scientific Python Ecosystem Summit in Seattle](./ecosystem_voting.jpg)

0 comments on commit ec37a94

Please sign in to comment.