Skip to content

Commit d5d8d5f

Browse files
docs: add bgms issue templates, defer config.yml to backlog
1 parent a912dfa commit d5d8d5f

3 files changed

Lines changed: 1061 additions & 0 deletions

File tree

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
name: Bug report
3+
about: Report something that is not working as expected.
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## What happened?
10+
11+
Describe what went wrong. Be as specific as you can.
12+
13+
## Which function were you using?
14+
15+
For example: `bgm()`, `bgmCompare()`, `simulate_mrf()`, `predict()`, or one
16+
of the extractor functions.
17+
18+
## Minimal example
19+
20+
If you can, paste a short R script that reproduces the problem. Starting from
21+
one of the built-in datasets (`Wenchuan`, `Boredom`, `ADHD`) or simulated data
22+
makes it easier for us to investigate.
23+
24+
```r
25+
library(bgms)
26+
27+
# your code here
28+
```
29+
30+
If the problem only occurs with your own data and you cannot share it, that is
31+
fine — describe the data instead: number of variables, number of observations,
32+
variable types (binary, ordinal, continuous), and any special characteristics
33+
such as missing values or low-frequency categories.
34+
35+
If the code produces an error message, paste the full message below.
36+
37+
```
38+
# error output here
39+
```
40+
41+
## What did you expect to happen?
42+
43+
Describe the result you expected instead.
44+
45+
## Session information
46+
47+
Paste the output of `sessionInfo()` below. This tells us your R version,
48+
operating system, and which packages are loaded — all of which help us
49+
reproduce the problem.
50+
51+
To get this, run the following in your R console and copy the output:
52+
53+
```r
54+
sessionInfo()
55+
```
56+
57+
```
58+
# paste sessionInfo() output here
59+
```
60+
61+
## Anything else?
62+
63+
Add any other context that might help: screenshots, related issues, or
64+
links to documentation.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature or improvement.
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## What problem does this solve?
10+
11+
Describe the situation or limitation that motivates this request.
12+
13+
## What would you like bgms to do?
14+
15+
Describe the behaviour or output you have in mind. If you have an idea of
16+
what the R code would look like, sketch it out — this helps us understand
17+
the interface you are imagining.
18+
19+
```r
20+
# optional: how you picture using the feature
21+
```
22+
23+
## Which area does this relate to?
24+
25+
For example: new variable type, edge prior, sampler, extractor function,
26+
summary or plot method, prediction, simulation, documentation, or
27+
something else.
28+
29+
## Would you like to help?
30+
31+
No pressure — we welcome feature requests regardless. But if you are
32+
interested in helping out, let us know. Contributions come in many forms:
33+
implementing the feature, writing tests, reviewing a pull request, or
34+
evaluating the results. We can help you get started.
35+
36+
## Anything else?
37+
38+
Add any other context, references, or examples from other packages that
39+
illustrate what you have in mind.

0 commit comments

Comments
 (0)