From ad037263147d3f874e0b2d5d58b6b5be30c6cd52 Mon Sep 17 00:00:00 2001 From: Caideyipi <87789683+Caideyipi@users.noreply.github.com> Date: Mon, 9 Nov 2026 14:30:02 +0800 Subject: [PATCH 1/2] docs: require examples in feature PR descriptions --- AGENTS.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index b58cd703af58..257f81de0650 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -28,6 +28,13 @@ For setup and compatibility notes, see [Coding agents](CONTRIBUTING.md#coding-ag Apache IoTDB is a time series database for IoT data. It uses a distributed architecture with ConfigNodes (metadata/coordination) and DataNodes (storage/query). Data is stored in TsFile columnar format (separate repo: https://github.com/apache/tsfile). Current version is 2.0.11-SNAPSHOT. +## Pull Request Descriptions + +Any PR that implements a new feature or changes an existing feature's definition or +user-visible behavior must include at least one concrete example in its description. Show +representative inputs and the resulting outputs or behavior; for a change to existing behavior, +make the before-and-after difference clear. + ## Branch Relationship and Backports - `master` is the primary development branch for the 2.x line. `dev/1.3` maintains the 1.3.x From 6c625a0e0c7d6143cd0009601b830ccd112b1678 Mon Sep 17 00:00:00 2001 From: Caideyipi <87789683+Caideyipi@users.noreply.github.com> Date: Mon, 9 Nov 2026 15:18:14 +0800 Subject: [PATCH 2/2] docs: describe bug scenarios in fix PRs --- AGENTS.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 257f81de0650..356785d276f5 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -34,6 +34,9 @@ Any PR that implements a new feature or changes an existing feature's definition user-visible behavior must include at least one concrete example in its description. Show representative inputs and the resulting outputs or behavior; for a change to existing behavior, make the before-and-after difference clear. +Bug-fix PRs should describe the scenario that triggers the bug, including relevant conditions or +inputs and the incorrect behavior observed; explain the corrected behavior when it helps clarify +the fix. ## Branch Relationship and Backports