From b2bef5ceef2bb9f96d22047070a6d5ccb3214605 Mon Sep 17 00:00:00 2001 From: Oliver Date: Sun, 16 Aug 2026 09:43:51 +0200 Subject: [PATCH] Update naming conventions and repository links to align with IB-Tool 3 standards --- README.md | 12 ++++++------ ai/core/architecture-guidelines.md | 2 +- ai/core/constraints.md | 2 +- ai/core/release-conventions.md | 4 ++-- ai/tasks/bugfix-task.md | 2 +- ai/tasks/new-feature-task.md | 2 +- ai/tasks/refactor-task.md | 2 +- docs/CHANGELOG.md | 6 +++--- docs/contributing.md | 10 +++++----- metadata.txt | 6 +++--- 10 files changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index fa5f811..a7a1ede 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # IB-Tool (Partitioning) — QGIS Plugin -[![CI](https://github.com/IB-Tool/ibtoolpartion/actions/workflows/ci.yml/badge.svg)](https://github.com/IB-Tool/ibtoolpartion/actions/workflows/ci.yml) -[![QGIS Plugin CI](https://github.com/IB-Tool/ibtoolpartion/actions/workflows/qgis-plugin-ci.yml/badge.svg)](https://github.com/IB-Tool/ibtoolpartion/actions/workflows/qgis-plugin-ci.yml) +[![CI](https://github.com/IB-Tool/Partitioning/actions/workflows/ci.yml/badge.svg)](https://github.com/IB-Tool/Partitioning/actions/workflows/ci.yml) +[![QGIS Plugin CI](https://github.com/IB-Tool/Partitioning/actions/workflows/qgis-plugin-ci.yml/badge.svg)](https://github.com/IB-Tool/Partitioning/actions/workflows/qgis-plugin-ci.yml) [![License: GPL-2.0-or-later](https://img.shields.io/badge/License-GPL--2.0--or--later-blue.svg)](LICENSE) A QGIS plugin that delineates settlement boundaries by partitioning spatial datasets based on building footprints. -This is a companion plugin to **[IBTool](https://github.com/IB-Tool/IB-Tool-3)**: -its output (a `PART_` polygon layer) is the **Partitions** input IBTool -expects — see IBTool's +This is a companion plugin to **[IB-Tool 3](https://github.com/IB-Tool/IB-Tool-3)**: +its output (a `PART_` polygon layer) is the **Partitions** input IB-Tool 3 +expects — see IB-Tool 3's [`docs/input-data.md` → Part](https://github.com/IB-Tool/IB-Tool-3/blob/master/docs/input-data.md#part--partitioning) and [`docs/quickstart.md`](https://github.com/IB-Tool/IB-Tool-3/blob/master/docs/quickstart.md) -for how it fits into IBTool's own workflow. +for how it fits into IB-Tool 3's own workflow. --- diff --git a/ai/core/architecture-guidelines.md b/ai/core/architecture-guidelines.md index 6e04254..62fa3a5 100644 --- a/ai/core/architecture-guidelines.md +++ b/ai/core/architecture-guidelines.md @@ -1,6 +1,6 @@ # Architecture Guidelines -Guidelines for architectural decisions in the IBTool project. +Guidelines for architectural decisions in the IB-Tool 3 project. ## Parameter Management diff --git a/ai/core/constraints.md b/ai/core/constraints.md index 3366806..408e232 100644 --- a/ai/core/constraints.md +++ b/ai/core/constraints.md @@ -1,6 +1,6 @@ # Constraints -Binding rules for all code changes in the IBTool project. +Binding rules for all code changes in the IB-Tool 3 project. For release-specific constraints (metadata.txt, LICENSE, ZIP packaging, CI), see [release-conventions.md](release-conventions.md). diff --git a/ai/core/release-conventions.md b/ai/core/release-conventions.md index b4f210b..3603e09 100644 --- a/ai/core/release-conventions.md +++ b/ai/core/release-conventions.md @@ -3,8 +3,8 @@ These rules are binding for all code changes. They are referenced from `CLAUDE.md` and `ai/core/constraints.md`. -Mirrors IBTool's own `ai/core/release-conventions.md` (the canonical version, -see [IB-Tool-3](https://github.com/IB-Tool/IB-Tool-3/blob/master/ai/core/release-conventions.md)), +Mirrors IB-Tool 3's own `ai/core/release-conventions.md` (the canonical version, +see [IB-Tool 3](https://github.com/IB-Tool/IB-Tool-3/blob/master/ai/core/release-conventions.md)), adapted for this plugin's folder name and repository. --- diff --git a/ai/tasks/bugfix-task.md b/ai/tasks/bugfix-task.md index 9c98dab..074955e 100644 --- a/ai/tasks/bugfix-task.md +++ b/ai/tasks/bugfix-task.md @@ -2,7 +2,7 @@ ## Purpose -Template for bug fixes in the IBTool project. Goal: minimal, targeted changes to resolve the reported issue. +Template for bug fixes in the IB-Tool 3 project. Goal: minimal, targeted changes to resolve the reported issue. ## Scope diff --git a/ai/tasks/new-feature-task.md b/ai/tasks/new-feature-task.md index 893c746..abfe297 100644 --- a/ai/tasks/new-feature-task.md +++ b/ai/tasks/new-feature-task.md @@ -2,7 +2,7 @@ ## Purpose -Template for implementing new functionality in the IBTool project. Goal: clean integration without affecting existing functionality. +Template for implementing new functionality in the IB-Tool 3 project. Goal: clean integration without affecting existing functionality. ## Scope diff --git a/ai/tasks/refactor-task.md b/ai/tasks/refactor-task.md index ab5671f..ef0c355 100644 --- a/ai/tasks/refactor-task.md +++ b/ai/tasks/refactor-task.md @@ -2,7 +2,7 @@ ## Purpose -Template for structural improvements in the IBTool project. Goal: better code structure without changing business logic. +Template for structural improvements in the IB-Tool 3 project. Goal: better code structure without changing business logic. ## Scope diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 97f061e..5006e89 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -11,13 +11,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - `Dockerfile` for Docker-based test execution (previously referenced by `ci.yml`/`docs/contributing.md` but missing). -- `scripts/create_release_zip.py` — release ZIP builder, mirroring IBTool's own script. -- Cross-links to IBTool's documentation (README, `docs/contributing.md`) describing this plugin's role as IBTool's Partitions input provider. +- `scripts/create_release_zip.py` — release ZIP builder, mirroring IB-Tool 3's own script. +- Cross-links to IB-Tool 3's documentation (README, `docs/contributing.md`) describing this plugin's role as IB-Tool 3's Partitions input provider. ### Fixed - `metadata.txt`: replaced placeholder `tracker`/`repository`/`homepage` URLs (`http://bugs`, `http://repo`, `http://homepage`) with the actual repository URLs; removed a stray unescaped line that was silently parsed as a bogus `category of the plugin` key; added a `changelog` entry (previously commented out). - `README.md`: removed incorrect reference to a non-existent `Test_data/LICENSE.txt`; removed stale `Test_data/.*` exclude pattern from `detect-secrets` examples (no such directory exists in this repo). -- `.github/workflows/ci.yml`: removed the "Dockerfile missing, see IB-Tool-3" comment now that a `Dockerfile` exists here. +- `.github/workflows/ci.yml`: removed the "Dockerfile missing, see IB-Tool 3" comment now that a `Dockerfile` exists here. --- diff --git a/docs/contributing.md b/docs/contributing.md index 837ade1..2c2f770 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -2,11 +2,11 @@ This document covers the development setup, CI/CD pipeline, test structure, and code quality tooling for IB-Tool (Partitioning). -This plugin is a companion to **[IBTool](https://github.com/IB-Tool/IB-Tool-3)** +This plugin is a companion to **[IB-Tool 3](https://github.com/IB-Tool/IB-Tool-3)** (the main plugin) and follows the same development conventions. For the canonical description of the CI/test/release approach shared by all three IB-Tool plugins, see -[IBTool's own `docs/contributing.md`](https://github.com/IB-Tool/IB-Tool-3/blob/master/docs/contributing.md). +[IB-Tool 3's own `docs/contributing.md`](https://github.com/IB-Tool/IB-Tool-3/blob/master/docs/contributing.md). This document only covers what differs here. --- @@ -34,7 +34,7 @@ Steps: 5. Uploads the coverage report to Codecov See `.github/workflows/ci.yml` and `Dockerfile` for the full definitions. The -image is a slimmed-down variant of IBTool's own `Dockerfile` — this plugin +image is a slimmed-down variant of IB-Tool 3's own `Dockerfile` — this plugin has no runtime dependencies beyond QGIS's own processing algorithms, so `numpy`/`scipy`/`networkx` are not installed. @@ -79,9 +79,9 @@ detect-secrets scan --force-use-all-plugins ## Release Process -Releases are built with `scripts/create_release_zip.py`, mirroring IBTool's +Releases are built with `scripts/create_release_zip.py`, mirroring IB-Tool 3's own release process (see -[IBTool's `docs/contributing.md` → Release Process](https://github.com/IB-Tool/IB-Tool-3/blob/master/docs/contributing.md) +[IB-Tool 3's `docs/contributing.md` → Release Process](https://github.com/IB-Tool/IB-Tool-3/blob/master/docs/contributing.md) for the full rationale). There is no automated GitHub release workflow — the ZIP is built and uploaded to GitHub Releases manually: diff --git a/metadata.txt b/metadata.txt index 8f75aa9..30295f7 100644 --- a/metadata.txt +++ b/metadata.txt @@ -12,8 +12,8 @@ email=ottmar.hittzfeld@web.de about=This tool generates a partition of the dataset based on building footprints. -tracker=https://github.com/IB-Tool/ibtoolpartion/issues -repository=https://github.com/IB-Tool/ibtoolpartion +tracker=https://github.com/IB-Tool/Partitioning/issues +repository=https://github.com/IB-Tool/Partitioning license=GPL-2.0-or-later # End of mandatory metadata @@ -25,7 +25,7 @@ changelog=0.1.0 - Initial release: KDE/Voronoi-based settlement partitioning. # Tags are comma separated with spaces allowed tags=python, settlement, partitioning, voronoi, kde, geodata, vector -homepage=https://github.com/IB-Tool/ibtoolpartion +homepage=https://github.com/IB-Tool/Partitioning category=Vector icon=icon.png # experimental flag