Commit ecc39af
committed
docs(repo): align conventional commit scopes with module structure
1 parent 4ff6b94 commit ecc39af
1 file changed
Lines changed: 23 additions & 23 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -94,27 +94,27 @@ Accepted types (standard): | |||
| 94 | 94 | - `style` – formatting/whitespace (no code behavior) | |
| 95 | 95 | - `test` – add/adjust tests only | |
| 96 | 96 | ||
| 97 | - Recommended scopes (match the smallest accurate directory/module): | ||
| 98 | - | ||
| 99 | - - Library/CLI scopes: | ||
| 100 | - - `cli` – `src/pythonnative/cli/` (the `pn` command) | ||
| 101 | - - `core` – `src/pythonnative/pythonnative/` package internals | ||
| 102 | - - `components` – UI view modules under `src/pythonnative/pythonnative/` (e.g., `button.py`, `label.py`) | ||
| 103 | - - `utils` – utilities like `utils.py` | ||
| 104 | - - `tests` – `tests/` | ||
| 105 | - | ||
| 106 | - - Templates and examples: | ||
| 107 | - - `templates` – `templates/` (Android/iOS templates, zips) | ||
| 108 | - - `examples` – `examples/` (e.g., `hello-world/`) | ||
| 109 | - | ||
| 110 | - <!-- Django app and site removed: the old Django project has been retired --> | ||
| 111 | - | ||
| 112 | - - Repo‑level and ops: | ||
| 97 | + Recommended scopes (choose the smallest, most accurate unit; prefer module/directory names): | ||
| 98 | + | ||
| 99 | + - Module/directory scopes: | ||
| 100 | + - `cli` – CLI tool and `pn` command (`src/pythonnative/cli/`) | ||
| 101 | + - `components` – declarative element-creating functions (`components.py`) | ||
| 102 | + - `element` – Element descriptor class (`element.py`) | ||
| 103 | + - `native_views` – platform-specific native view creation and updates (`native_views.py`) | ||
| 104 | + - `package` – `src/pythonnative/__init__.py` exports and package boundary | ||
| 105 | + - `page` – Page component, lifecycle, and reactive state (`page.py`) | ||
| 106 | + - `reconciler` – virtual view tree diffing and reconciliation (`reconciler.py`) | ||
| 107 | + - `utils` – shared utilities (`utils.py`) | ||
| 108 | + | ||
| 109 | + - Other scopes: | ||
| 113 | 110 | - `deps` – dependency updates and version pins | |
| 114 | - - `docker` – containerization files (e.g., `Dockerfile`) | ||
| 115 | - - `repo` – top‑level files (`README.md`, `CONTRIBUTING.md`, `.gitignore`, licenses) | ||
| 111 | + - `examples` – example apps under `examples/` | ||
| 116 | 112 | - `mkdocs` – documentation site (MkDocs/Material) configuration and content under `docs/` | |
| 117 | - - `workflows` – CI pipelines (e.g., `.github/workflows/`) | ||
| 113 | + - `pyproject` – `pyproject.toml` packaging/build metadata | ||
| 114 | + - `repo` – repository metadata and top‑level files (`README.md`, `CONTRIBUTING.md`, `.gitignore`, licenses) | ||
| 115 | + - `templates` – Android/iOS project templates under `src/pythonnative/templates/` | ||
| 116 | + - `tests` – unit/integration/E2E tests under `tests/` | ||
| 117 | + - `workflows` – CI pipelines under `.github/workflows/` | ||
| 118 | 118 | ||
| 119 | 119 | Note: Avoid redundant type==scope pairs (e.g., `docs(docs)`). Prefer a module scope (e.g., `docs(core)`) or `docs(repo)` for top‑level updates. | |
| 120 | 120 | ||
@@ -124,12 +124,12 @@ Examples: | |||
| 124 | 124 | build(deps): refresh pinned versions | |
| 125 | 125 | chore(repo): add contributing guidelines | |
| 126 | 126 | ci(workflows): add publish job | |
| 127 | - docs(core): clarify ListView data contract | ||
| 128 | - feat(components): add MaterialSearchBar | ||
| 127 | + docs(reconciler): clarify diffing algorithm | ||
| 128 | + feat(components): add Slider element | ||
| 129 | 129 | fix(cli): handle missing Android SDK gracefully | |
| 130 | - perf(core): reduce allocations in list diffing | ||
| 130 | + perf(reconciler): reduce allocations in list diffing | ||
| 131 | 131 | refactor(utils): extract path helpers | |
| 132 | - test(tests): cover ios template copy flow | ||
| 132 | + test: cover iOS template copy flow | ||
| 133 | 133 | ``` | |
| 134 | 134 | ||
| 135 | 135 | Examples (no scope): | |
0 commit comments