Sitelet https://github.com/open-telemetry/otel-arrow/commit/80a995ddbf4fd597c897dae3b5ebfcffbbd97dfd
Skip to content

Commit 80a995d

Browse files
drewrelmasdrewrelmas
authored
chore(repo): Revise pull request template and AGENTS.md for better guidance (#3371)
Updated the pull request template to improve clarity and instructions. # Change Summary Update PR template to mention doc-only PRs to prevent AI comments like #3369 (comment): > PR description indicates the changelog requirement is satisfied (either a .chloggen/*.yaml entry was added or the PR title is a chore), but this PR appears to add only documentation and the title is docs:. Per rust/otap-dataflow/AGENTS.md:110-123, skipping a Rust changelog entry requires chore in the PR title; otherwise add a .chloggen/*.yaml entry if this doc is considered user-facing. ## What issue does this PR close? N/A ## How are these changes tested? N/A ## Are there any user-facing changes? Yes, changes to PR description ### Changelog <!-- User-facing changes need a .chloggen/*.yaml entry. Copy the TEMPLATE.yaml in go/.chloggen/ or rust/otap-dataflow/.chloggen/ and fill in the fields. If not required, include `chore` in the PR title. --> * [ ] Added a `.chloggen/*.yaml` entry * [x] This PR is a `chore` (indicated in title) * [ ] This is a documentation-only PR.
1 parent 88d6360 commit 80a995d

3 files changed

Lines changed: 10 additions & 8 deletions

File tree

‎.github/pull_request_template.md‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
# Change Summary
22

3-
<!--
4-
Replace with a brief summary of the change in this PR
5-
-->
3+
<!--Replace with a brief summary of the change in this PR-->
64

75
## What issue does this PR close?
86

9-
<!--
10-
We highly recommend correlation of every PR to an issue
11-
-->
7+
<!--We highly recommend correlation of every PR to an issue-->
128

139
* Closes #NNN
1410

@@ -26,4 +22,6 @@ in go/.chloggen/ or rust/otap-dataflow/.chloggen/ and fill in the fields.
2622
If not required, include `chore` in the PR title.
2723
-->
2824

29-
* [ ] Added a `.chloggen/*.yaml` entry, OR this PR is a `chore` (indicated in title).
25+
* [ ] Added a `.chloggen/*.yaml` entry
26+
* [ ] This PR is a `chore` (indicated in title)
27+
* [ ] This is a documentation-only PR.

‎AGENTS.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ Required fields: `change_type` (one of `breaking`, `deprecation`,
2121
directory's `config.yaml`), `note`, and `issues`.
2222

2323
Skip the entry only when the change is not user-facing (build chores, internal
24-
refactors, doc-only edits, dev-only dependency bumps). In that case include
24+
refactors, dev-only dependency bumps). In that case include
2525
`chore` in the PR title.
2626

27+
Doc-only PRs are also excluded from the changelog requirement.
28+
2729
See [`CONTRIBUTING.md`](CONTRIBUTING.md#changelog-entries) for full details.

‎rust/otap-dataflow/AGENTS.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,8 @@ Required fields: `change_type` (one of `breaking`, `deprecation`,
121121
Skip the entry only when the change is not user-facing. In that case include
122122
`chore` in the PR title.
123123

124+
Doc-only PRs are also excluded from the changelog requirement.
125+
124126
See [`.chloggen/README.md`](.chloggen/README.md) for full details.
125127

126128
## Before finalizing changes

0 commit comments

Comments
 (0)