This is an automated email from the ASF dual-hosted git repository.
jt2594838 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new cd31721c147 docs: require examples in feature PR descriptions (#19191)
cd31721c147 is described below
commit cd31721c1476b8edd07c4f205acd2fb4e046bc6d
Author: Caideyipi <[email protected]>
AuthorDate: Mon Nov 9 16:03:49 2026 +0800
docs: require examples in feature PR descriptions (#19191)
* docs: require examples in feature PR descriptions
* docs: describe bug scenarios in fix PRs
---
AGENTS.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/AGENTS.md b/AGENTS.md
index b58cd703af5..356785d276f 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -28,6 +28,16 @@ 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.
+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
- `master` is the primary development branch for the 2.x line. `dev/1.3`
maintains the 1.3.x