Skip to content

Commit 42a6318

Browse files
committed
add issue templates
1 parent b0f5047 commit 42a6318

File tree

4 files changed

+122
-0
lines changed

4 files changed

+122
-0
lines changed
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: API Documentation Improvement
2+
description: Suggest an improvement for the API documentation.
3+
title: "[API Documentation]: "
4+
labels: ["documentation"]
5+
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Describe the issue related to the API documentation
10+
validations:
11+
required: true
12+
- type: textarea
13+
attributes:
14+
label: Suggested alternative or fix
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
assignees:
6+
- PhilippBach
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for taking the time to fill out this bug report!
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Describe the bug
17+
description: |
18+
Please provide a clear and concise discription of the bug.
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: mwe
23+
attributes:
24+
label: Minimum reproducible code snippet
25+
description: |
26+
Please provide a short reproducible code snippet. Example:
27+
28+
```R
29+
library(DoubleML)
30+
library(mlr3)
31+
library(mlr3learners)
32+
library(data.table)
33+
set.seed(2)
34+
ml_g = lrn("regr.ranger", num.trees = 10, max.depth = 2)
35+
ml_m = ml_g$clone()
36+
obj_dml_data = make_plr_CCDDHNR2018(alpha = 0.5)
37+
dml_plr_obj = DoubleMLPLR$new(obj_dml_data, ml_g, ml_m)
38+
dml_plr_obj$fit()
39+
dml_plr_obj$summary()
40+
```
41+
placeholder: |
42+
43+
```R
44+
Sample code here
45+
```
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: expected
50+
attributes:
51+
label: Expected Result
52+
description: |
53+
State the result you would have expected
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: actual
58+
attributes:
59+
label: Actual Result
60+
description: |
61+
State the result you get (for example an exception including the full traceback)
62+
validations:
63+
required: true
64+
- type: textarea
65+
id: versions
66+
attributes:
67+
label: Versions
68+
description: |
69+
Please run the following code and copy-paste the result
70+
71+
```R
72+
sessionInfo()
73+
packageVersion('DoubleML')
74+
packageVersion('mlr3')
75+
```
76+
validations:
77+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Discussions
4+
url: https://github.com/DoubleML/doubleml-for-r/discussions/new
5+
about: Ask questions about the DoubleML package or start related dicussions
6+
- name: Documentation and User Guide
7+
url: https://github.com/DoubleML/doubleml-docs/issues/new/choose
8+
about: Issues related to the documentation and user guide on docs.doubleml.org should be reported in the doubleml-docs repo
9+
- name: Blank Issue
10+
url: https://github.com/DoubleML/doubleml-for-r/issues/new
11+
about: Please note that often Dicussions is the better choice
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Feature Request
2+
description: Suggest an enhancement or extension for the DoubleML package
3+
title: "[Feature Request]: "
4+
labels: ["new feature", "enhancement"]
5+
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Describe the feature you want to propose or implement
10+
validations:
11+
required: true
12+
- type: textarea
13+
attributes:
14+
label: Propose a possible solution or implementation
15+
- type: textarea
16+
attributes:
17+
label: Did you consider alternatives to the proposed solution. If yes, please describe
18+
- type: textarea
19+
attributes:
20+
label: Comments, context or references

0 commit comments

Comments
 (0)