Skip to content

Commit b5687b6

Browse files
sbfnk-botsbfnk
andauthored
Reduce NEWS.md merge conflicts between parallel PRs (#1509)
Co-authored-by: sbfnk <sebastian.funk@lshtm.ac.uk>
1 parent 29adb6c commit b5687b6

3 files changed

Lines changed: 19 additions & 4 deletions

File tree

.gitattributes

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Bullets are independent lines, so keep both sides instead of conflicting
2+
# when parallel PRs each add a news item.
3+
NEWS.md merge=union

CLAUDE.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,14 @@ test_that("calc_CrI works as expected with default arguments", {
8787
- Don't reference issue numbers - those are for PRs, not NEWS
8888
- Don't mention code generators/reviewers or @ mentions
8989
- Keep entries relatively short (default: 1 sentence, but can be more if needed)
90-
- Organize by section: "Package changes", "Model changes", "Bug fixes", "Documentation"
90+
- Organise by section: "New features", "Breaking changes", "Model changes",
91+
"Package changes", "Bug fixes", "Documentation"
92+
- Add your bullet to a section that already exists rather than creating a
93+
heading. The development section is seeded with all standard headings,
94+
empty, when the version is bumped, and the release PR removes any that are
95+
still empty. This keeps parallel PRs from colliding on the headings
96+
themselves, and lets `NEWS.md merge=union` in `.gitattributes` resolve the
97+
bullets automatically
9198
- Start with action verbs: "Added", "Fixed", "Updated", "Changed"
9299
- Bug fixes often start: "A bug was fixed where..."
93100

NEWS.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,24 @@
11
# EpiNow2 (development version)
22

3-
## Bug fixes
3+
## New features
44

5-
- A bug was fixed where disabling the weekly reporting effect produced a spurious convergence warning from a degenerate day-of-week simplex.
6-
- A bug was fixed where `estimate_infections()` could emit a spurious "the largest R-hat is NA" convergence warning caused by deterministic delay PMFs being monitored; these are no longer monitored.
5+
## Breaking changes
6+
7+
## Model changes
78

89
## Package changes
910

1011
- Increased the default number of warmup iterations in `stan_sampling_opts()` from 250 to 500 to reduce intermittent non-convergence of individual chains.
1112

1213
## Bug fixes
1314

15+
- A bug was fixed where disabling the weekly reporting effect produced a spurious convergence warning from a degenerate day-of-week simplex.
16+
- A bug was fixed where `estimate_infections()` could emit a spurious "the largest R-hat is NA" convergence warning caused by deterministic delay PMFs being monitored; these are no longer monitored.
1417
- A bug was fixed where the prior on the initial reproduction number was applied with an incorrect Jacobian, shifting it upwards by a factor of `exp(sdlog^2)`. A `LogNormal(mean = 2, sd = 1)` prior was applied as though it had a mean of 2.5.
1518
- A bug was fixed where the mean reproduction number over the observation window was left uninitialised, so chains started from a value drawn across the whole of `exp(-2)` to `exp(2)` rather than from the user's Rt prior.
1619

20+
## Documentation
21+
1722
## Internal
1823

1924
- Removed redundant namespace qualification (`pkg::fn`) on imported functions across the package, and excluded `data-raw` from linting, so `lintr` passes cleanly.

0 commit comments

Comments
 (0)