Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions content/contributing/layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -25,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.

Expand Down
Loading