Skip to content
Merged
Show file tree
Hide file tree
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
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,19 @@ merging are disabled to keep that history consistent.
After a pull request is merged, GitHub deletes its remote branch automatically.
Delete the corresponding local branch after updating `main`.

## Documentation terminology

Use the official spelling of tool names: `uv` and pytest are lowercase, while
Ruff is capitalized in prose. Keep command names and configuration keys in code
format.

Call the ordered set of core chapters the **main learning path**. Call the
supporting quickstarts, troubleshooting pages, and focused guides
**reference material**.

When a documentation example reproduces this repository's `pyproject.toml`,
keep its dependency constraints aligned with the real configuration.

## Local checks

Before opening a pull request with code changes, run the local quality checks:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![CI](https://github.com/michalmaj/modern-python-project-guide/actions/workflows/ci.yml/badge.svg)](https://github.com/michalmaj/modern-python-project-guide/actions/workflows/ci.yml)

A practical, beginner-friendly guide to building a clean Python project with
`uv`, `pytest`, Ruff, `pyproject.toml`, GitHub Actions, and a pull request based
`uv`, `pytest`, Ruff, `pyproject.toml`, GitHub Actions, and a pull-request-based
workflow.

This repository is both a tutorial and a working example. It introduces each
Expand Down
4 changes: 2 additions & 2 deletions docs/02_uv.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ Examples:
```bash
uv init --package
uv sync
uv add pytest --dev
uv add ruff --dev
uv add --group dev pytest
uv add --group dev ruff
uv run pytest
uv run ruff check .
uv run ruff format .
Expand Down
9 changes: 3 additions & 6 deletions docs/ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,15 +122,12 @@ These parts are already included in the repository.
- [x] Separate the main learning path from reference material
- [x] Add previous and next navigation to the core chapters
- [x] Review commit history and self-review coverage in the existing guides
- [x] Standardize terminology and dependency examples across the documentation

## Next

These are good candidates for upcoming small pull requests.

### Documentation polish

- [ ] Review terminology consistency

### Repository polish

- [ ] Add issue templates only if the repository starts receiving external feedback
Expand All @@ -141,7 +138,7 @@ These are good candidates for upcoming small pull requests.
- [ ] Consider `Makefile` as an optional convenience layer
- [ ] Consider `just` as an alternative task runner

Task runners should not replace the basic commands in the first learning path.
Task runners should not replace the basic commands in the main learning path.

They should be introduced only as convenience wrappers after the underlying commands are clear.

Expand Down Expand Up @@ -193,7 +190,7 @@ They may be added later as separate chapters.

## Not planned for the first version

These are deliberately excluded from the first learning path:
These are deliberately excluded from the main learning path:

- Docker,
- publishing to PyPI,
Expand Down
2 changes: 1 addition & 1 deletion docs/cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This page is a quick command reference.

It does not explain every concept in detail.

For explanations, use the full guide and quickstarts.
For explanations, use the main learning path and quickstarts.

## Project setup

Expand Down
2 changes: 1 addition & 1 deletion docs/common_questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ This repository focuses on the Python project foundation first:

Docker can be introduced later when there is a clear reason for it.

Adding it too early would make the guide heavier without helping the core learning path.
Adding it too early would make the guide heavier without helping the main learning path.

## Why not add pre-commit?

Expand Down
6 changes: 3 additions & 3 deletions docs/example_pull_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ The `Why` section explains the motivation.
Good example:

```text
Readers who already understand the concepts may want a compact command reference instead of searching through the full guide.
Readers who already understand the concepts may want a compact command reference instead of searching through the main learning path.
```

Bad example:
Expand Down Expand Up @@ -217,7 +217,7 @@ Summary:
Adds a command cheatsheet for common project, uv, Ruff, pytest, Git, and CI commands.

Why:
Readers who already understand the concepts may want a compact command reference instead of searching through the full guide and quickstarts.
Readers who already understand the concepts may want a compact command reference instead of searching through the main learning path and quickstarts.

Changes:
- Adds docs/cheatsheet.md
Expand Down Expand Up @@ -351,4 +351,4 @@ I understand why it changed.
I know how it was checked.
```

If the reviewer has to guess, improve the pull request description before asking for review.
If the reviewer has to guess, improve the pull request description before asking for review.
4 changes: 2 additions & 2 deletions docs/from_script_to_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,8 +247,8 @@ build-backend = "uv_build"

[dependency-groups]
dev = [
"pytest>=8.0.0",
"ruff>=0.11.0",
"pytest>=9.0.3",
"ruff>=0.15.12",
]

[tool.pytest.ini_options]
Expand Down
4 changes: 2 additions & 2 deletions docs/markdown_review.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ Examples of topics that should not be pushed into the foundation too early:

These topics may be useful later.

They should not distract from the first learning path.
They should not distract from the main learning path.

## Check tone

Expand Down Expand Up @@ -405,4 +405,4 @@ The maintainer checks correctness.

The reader checks clarity.

A good documentation change should satisfy both.
A good documentation change should satisfy both.
4 changes: 2 additions & 2 deletions docs/quickstart_uv.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,8 +184,8 @@ build-backend = "uv_build"

[dependency-groups]
dev = [
"pytest>=8.0.0",
"ruff>=0.11.0",
"pytest>=9.0.3",
"ruff>=0.15.12",
]

[tool.pytest.ini_options]
Expand Down
4 changes: 2 additions & 2 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,8 @@ Check that `pyproject.toml` contains something similar to:
```toml
[dependency-groups]
dev = [
"pytest>=8.0.0",
"ruff>=0.11.0",
"pytest>=9.0.3",
"ruff>=0.15.12",
]
```

Expand Down
Loading