Skip to content

docs: require examples in feature PR descriptions #19191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jt2594838 merged 2 commits into from
Nov 9, 2026
+10 −0
Merged

docs: require examples in feature PR descriptions #19191

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad03726
docs: require examples in feature PR descriptions
Caideyipi Nov 9, 2026
6c625a0
docs: describe bug scenarios in fix PRs
Caideyipi Nov 9, 2026
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
10 changes: 10 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading