Skip to content

Commit 0bc9b20

Browse files
Paul-Bobclaude
andcommitted
feat: ask PR authors for a release-note line (AVO-1551)
Release notes derived from PR titles read like a commit log. This adds the section an author fills in — one customer-facing line plus a type — which becomes Avo's release notes and feeds the monthly "what shipped" rollup that the changelog post and newsletter are written from. No package field here, unlike the monorepo's template: every PR in this repository is the `avo` gem, so naming it would be noise on every PR. The check that reports on this section is not in this PR. Sharing one parser across both repositories means reading it from avo-hq/workspace, which is private — so a check here would need a credential that does not exist yet, and would put private source on a public repository's runner. That tradeoff wants a decision before it ships; the template is useful on its own in the meantime. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 72d9a41 commit 0bc9b20

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,25 @@ Fixes # (issue)
77
By submitting the Contribution, you acknowledge that you have read the Contributor License Agreement at https://avohq.io/cla and agree to be bound by its terms.
88
-->
99

10+
## Release note
11+
12+
<!-- release-note-help
13+
This becomes the customer-facing line in Avo's release notes and feeds the
14+
monthly "what shipped" rollup. Write it for someone who uses Avo, not for a
15+
reviewer reading the diff.
16+
17+
Note one line, no trailing period
18+
Type feature | fix | improvement | internal
19+
20+
Use `internal` for changes users never see — CI, tooling, docs. A check
21+
reports a missing or unparseable note but never blocks the merge.
22+
23+
Delete this comment once you have filled the two lines in.
24+
-->
25+
26+
Note:
27+
Type:
28+
1029
# Checklist:
1130
<!--
1231
Please go through the steps and complete them if they make sense (add tests if the change requires it, add to the docs, etc.)

0 commit comments

Comments
 (0)