Skip to content

Commit 4d674f4

Browse files
docs: add bgms pull request template
1 parent c2e007d commit 4d674f4

1 file changed

Lines changed: 68 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
## Description
2+
3+
Provide a concise summary of the changes.
4+
5+
### Problem / Motivation
6+
7+
If this is a bug fix, describe the specific problem or edge case being
8+
addressed. If this is a methodological update, explain the theoretical gap or
9+
need for the change.
10+
11+
If helpful, add a minimal code example that demonstrates the problem.
12+
13+
```r
14+
# Problem demonstration
15+
```
16+
17+
### Proposed Changes / New Functionality
18+
19+
Describe the new functionality or logic introduced. Note whether this affects
20+
prior specifications, sampling algorithms in `src/`, summary outputs, or user
21+
facing R functions.
22+
23+
Fixes #
24+
25+
If helpful, add a minimal code example that demonstrates the new behaviour.
26+
27+
```r
28+
# New behaviour
29+
```
30+
31+
## Type of Change
32+
33+
- [ ] Bug fix
34+
- [ ] New feature
35+
- [ ] Breaking change
36+
- [ ] Documentation update
37+
- [ ] Performance optimization
38+
- [ ] Statistical / methodological update
39+
40+
## Documentation and Release Notes
41+
42+
- [ ] Updated function documentation for any signature or behaviour changes
43+
- [ ] Regenerated `man/*.Rd` files if roxygen comments changed
44+
- [ ] Updated `_pkgdown.yml` if adding a new exported function
45+
- [ ] Added or updated `NEWS.md` entry if the change affects users
46+
47+
## Testing and Validation
48+
49+
Describe the checks you ran and the main results.
50+
51+
- [ ] Added or updated tests in `tests/testthat/` when needed
52+
- [ ] Ran the project styler
53+
54+
```r
55+
source("inst/styler/bgms_style.R")
56+
styler::style_pkg(style = bgms_style)
57+
```
58+
59+
- [ ] Checked test files for styled `result =` captures that must be reverted to `result <-`
60+
- [ ] Ran `lintr::lint_package()`
61+
- [ ] Ran `roxygen2::roxygenise()` if roxygen comments changed
62+
- [ ] Ran `rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"))` for non-trivial changes
63+
- [ ] Verified numerical behaviour where relevant
64+
65+
## Additional Notes
66+
67+
List any reviewer context that is important for evaluation: open design
68+
questions, follow-up work, expected numerical differences, or known limits.

0 commit comments

Comments
 (0)