From a89af5f69ac2a70e1097cffbf4852e54d2d1bad8 Mon Sep 17 00:00:00 2001 From: Edward G Date: Sun, 31 May 2026 21:08:11 -0700 Subject: [PATCH 1/3] Add standard layout. --- content/contributing/layout.md | 37 ++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/content/contributing/layout.md b/content/contributing/layout.md index e626d1b..723415a 100644 --- a/content/contributing/layout.md +++ b/content/contributing/layout.md @@ -8,6 +8,43 @@ projects. The more a project begins to diverge, the more likely it is to cause an issue at an inopportune time. If something here is changed in one project, it should be applied to all others as well. +## Standard Layout + +* root + * .devcontainer + * .github + * ISSUE_TEMPLATE + * bug-report.md + * config.yml + * feature-request + * workflows + * lock.yml + * pre-commit.yml + * publish.yml + * tests.yml + * zizmor.yaml + * pull_request_template.md + * docs + * _static + * documentation files + * conf.py + * examples + * folders containing examples + * README + * src + * package_name eg click + * tests + * .editorconfig + * .gitignore + * .pre-commit-config.yml + * .readthedocs.yml + * CHANGES.rst + * LICENSE.txt + * README.md + * pyproject.toml + * uv.lock + + ## Requirements Files Each development environment uses a requirements file and the [pip-tools] and From 3483d2e0c291ea26dc739b9bf8e35bf5e6f93624 Mon Sep 17 00:00:00 2001 From: Edward G Date: Sun, 31 May 2026 21:13:11 -0700 Subject: [PATCH 2/3] Add example config for pytest. --- content/contributing/layout.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/content/contributing/layout.md b/content/contributing/layout.md index 723415a..516889e 100644 --- a/content/contributing/layout.md +++ b/content/contributing/layout.md @@ -62,8 +62,18 @@ We do not use Dependabot to update these files as it is too noisy. ## Tests +### Pytest [pytest] is used to run the tests, found in the `tests` folder. +Pytest configuration in pyproject.toml +``` +[tool.pytest.ini_options] +testpaths = ["tests"] +filterwarnings = [ + "error", +] +``` + [tox] is used to run different test environments, including Python versions, style checks, documentation, and typing. The `tox.ini` file configures this. From 3828128d2222050d284b60235732b9ec7d166fbd Mon Sep 17 00:00:00 2001 From: Edward G Date: Sun, 31 May 2026 21:21:23 -0700 Subject: [PATCH 3/3] Make precommit happy. --- content/contributing/layout.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/content/contributing/layout.md b/content/contributing/layout.md index 516889e..5ec0a6f 100644 --- a/content/contributing/layout.md +++ b/content/contributing/layout.md @@ -10,32 +10,32 @@ project, it should be applied to all others as well. ## Standard Layout -* root - * .devcontainer - * .github +* root + * .devcontainer + * .github * ISSUE_TEMPLATE - * bug-report.md + * bug-report.md * config.yml * feature-request - * workflows + * workflows * lock.yml - * pre-commit.yml + * pre-commit.yml * publish.yml * tests.yml * zizmor.yaml * pull_request_template.md - * docs - * _static - * documentation files + * docs + * _static + * documentation files * conf.py * examples - * folders containing examples + * folders containing examples * README - * src + * src * package_name eg click * tests * .editorconfig - * .gitignore + * .gitignore * .pre-commit-config.yml * .readthedocs.yml * CHANGES.rst @@ -65,7 +65,7 @@ We do not use Dependabot to update these files as it is too noisy. ### Pytest [pytest] is used to run the tests, found in the `tests` folder. -Pytest configuration in pyproject.toml +Pytest configuration in pyproject.toml ``` [tool.pytest.ini_options] testpaths = ["tests"]