Skip to content

Commit 2b70851

Browse files
wouterwlnwouterwln
committed
Add issue templates
1 parent db967a9 commit 2b70851

File tree

7 files changed

+559
-0
lines changed

7 files changed

+559
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior in ReactiveMP
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the form below to help us understand and fix the issue. Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/ReactiveBayes/ReactiveMP.jl/issues?q=is%3Aissue+sort%3Acreated-desc+). Additionally, make sure that you've searched relevant information in the [documentation](https://reactivebayes.github.io/ReactiveMP.jl/stable/).
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: A clear and concise description of what the bug is
16+
placeholder: Describe the bug...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: expected
22+
attributes:
23+
label: Expected Behavior
24+
description: What you expected to happen
25+
placeholder: Describe what you expected...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: actual
31+
attributes:
32+
label: Actual Behavior
33+
description: What actually happened
34+
placeholder: Describe what actually happened...
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: code
40+
attributes:
41+
label: Minimal Reproducible Example or steps to reproduce the issue
42+
description: Please provide a minimal code example that reproduces the issue
43+
placeholder: |
44+
```julia
45+
using ReactiveMP
46+
# Your minimal example here
47+
```
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: error
53+
attributes:
54+
label: Error Message / Stack Trace
55+
description: If applicable, paste the full error message or stack trace
56+
placeholder: Paste error message here...
57+
render: shell
58+
59+
- type: dropdown
60+
id: julia-version
61+
attributes:
62+
label: Julia Version
63+
description: What version of Julia are you using?
64+
options:
65+
- "1.10"
66+
- "1.11"
67+
- "1.12"
68+
- "Other (please specify in additional context)"
69+
validations:
70+
required: true
71+
72+
- type: dropdown
73+
id: reactivemp-version
74+
attributes:
75+
label: ReactiveMP Version
76+
description: What version of ReactiveMP are you using?
77+
options:
78+
- "Latest stable"
79+
- "Latest dev"
80+
- "Other (please specify in additional context)"
81+
validations:
82+
required: true
83+
84+
- type: textarea
85+
id: environment
86+
attributes:
87+
label: Environment Information
88+
description: |
89+
Please provide information about your environment (OS, package versions, etc.)
90+
You can run `] status` in Julia to get package versions.
91+
placeholder: |
92+
- OS: [e.g., macOS 14.0, Linux Ubuntu 22.04, Windows 11]
93+
- Package versions: [paste output of `] status`]
94+
render: shell
95+
96+
- type: textarea
97+
id: additional
98+
attributes:
99+
label: Additional Context
100+
description: Add any other context, screenshots, or information about the problem here
101+
placeholder: Any additional information...
102+

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 💬 Discussions / Q&A (RxInfer)
4+
url: https://github.com/reactivebayes/RxInfer.jl/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: 📚 Documentation
7+
url: https://reactivebayes.github.io/ReactiveMP.jl/stable/
8+
about: Check out our documentation for guides and API reference
9+
- name: 🎯 Examples (RxInfer)
10+
url: https://examples.rxinfer.com
11+
about: Browse example models and use cases
12+

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Documentation Issue
2+
description: Report an issue with documentation (missing, unclear, or incorrect information)
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve ReactiveMP's documentation! Please fill out the form below.
10+
11+
- type: dropdown
12+
id: issue-type
13+
attributes:
14+
label: Type of Documentation Issue
15+
description: What kind of documentation issue is this?
16+
options:
17+
- "Missing documentation"
18+
- "Unclear or confusing"
19+
- "Incorrect information"
20+
- "Broken link"
21+
- "Formatting issue"
22+
- "Other"
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: description
28+
attributes:
29+
label: Description
30+
description: A clear description of the documentation issue
31+
placeholder: Describe the issue...
32+
validations:
33+
required: true
34+
35+
- type: input
36+
id: page-url
37+
attributes:
38+
label: Documentation Page URL
39+
description: Link to the affected documentation page (if applicable)
40+
placeholder: "https://reactivebayes.github.io/ReactiveMP.jl/stable/..."
41+
42+
- type: textarea
43+
id: current-content
44+
attributes:
45+
label: Current Content (if applicable)
46+
description: What the documentation currently says (copy/paste relevant sections)
47+
placeholder: Paste current documentation content here...
48+
49+
- type: textarea
50+
id: expected-content
51+
attributes:
52+
label: Expected Content / Suggested Fix
53+
description: What the documentation should say, or how it should be improved
54+
placeholder: Describe what should be changed or added...
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: context
60+
attributes:
61+
label: Additional Context
62+
description: Any additional context, examples, or information that would help improve the documentation
63+
placeholder: Additional context...
64+

‎.github/ISSUE_TEMPLATE/epic.yml‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: Epic
2+
description: Create an epic for a large-scale project that will be broken down into Features and Tasks
3+
title: "Epic: "
4+
labels: ["epic"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Epics are large-scale projects that span multiple features and tasks. Use this template to define a high-level project that will be broken down into smaller work items.
10+
11+
- type: textarea
12+
id: summary
13+
attributes:
14+
label: Epic Summary
15+
description: A high-level summary of the epic and its goals
16+
placeholder: Provide a brief overview of what this epic aims to achieve...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: motivation
22+
attributes:
23+
label: Motivation / Problem Statement
24+
description: Why is this epic needed? What problem does it solve?
25+
placeholder: Describe the motivation and problem this epic addresses...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: goals
31+
attributes:
32+
label: Epic Goals
33+
description: What are the main goals and success criteria for this epic?
34+
placeholder: |
35+
- Goal 1
36+
- Goal 2
37+
- Success criteria
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: features
43+
attributes:
44+
label: Features
45+
description: |
46+
List the main features that compose this epic. Each feature should be a high-level capability.
47+
Features will be broken down into tasks later.
48+
placeholder: |
49+
## Feature 1: [Feature Name]
50+
- Description of what this feature provides
51+
- Key capabilities
52+
53+
## Feature 2: [Feature Name]
54+
- Description of what this feature provides
55+
- Key capabilities
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
id: dependencies
61+
attributes:
62+
label: Dependencies
63+
description: Are there any dependencies on other issues, PRs, or external factors?
64+
placeholder: |
65+
- Dependency 1
66+
- Dependency 2
67+
68+
- type: textarea
69+
id: timeline
70+
attributes:
71+
label: Estimated Timeline
72+
description: Rough estimate of when this epic should be completed (if known)
73+
placeholder: "Q1 2025, Q2 2025, etc."
74+
75+
- type: textarea
76+
id: related
77+
attributes:
78+
label: Related Issues / PRs
79+
description: Link to any related issues, PRs, or discussions
80+
placeholder: |
81+
- Related to #123
82+
- Blocks #456
83+
84+
- type: textarea
85+
id: additional
86+
attributes:
87+
label: Additional Context
88+
description: Any other relevant information about this epic
89+
placeholder: Additional context...
90+

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
name: Feature
2+
description: Create a Feature that belongs to an Epic and will be broken down into Tasks
3+
title: "Feature: "
4+
labels: ["feature"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**Note:** This template is for Scrum terminology (Epic → Feature → Task). If you're requesting a new feature or enhancement for ReactiveMP, please use the "Feature Request" template instead.
10+
11+
Features are high-level capabilities that belong to an Epic. Use this template to define a feature that will be broken down into specific tasks.
12+
13+
- type: input
14+
id: epic-reference
15+
attributes:
16+
label: Parent Epic
17+
description: Link to the Epic this feature belongs to (use #issue-number)
18+
placeholder: "#123"
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: summary
24+
attributes:
25+
label: Feature Summary
26+
description: A clear and concise summary of what this feature provides
27+
placeholder: Provide a brief overview of what this feature aims to deliver...
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: description
33+
attributes:
34+
label: Feature Description
35+
description: Detailed description of the feature, its capabilities, and how it fits into the parent Epic
36+
placeholder: Describe the feature in detail...
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: goals
42+
attributes:
43+
label: Feature Goals
44+
description: What are the main goals and acceptance criteria for this feature?
45+
placeholder: |
46+
- Goal 1
47+
- Goal 2
48+
- Acceptance criteria
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: tasks
54+
attributes:
55+
label: Tasks
56+
description: |
57+
List the tasks that compose this feature. Tasks should be specific, actionable items.
58+
You can create separate Task issues for each item or add more tasks as the feature progresses.
59+
placeholder: |
60+
- [ ] Task 1: [Description]
61+
- [ ] Task 2: [Description]
62+
- [ ] Task 3: [Description]
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: dependencies
68+
attributes:
69+
label: Dependencies
70+
description: Are there any dependencies on other features, issues, PRs, or external factors?
71+
placeholder: |
72+
- Depends on feature #456
73+
- Blocks feature #789
74+
75+
- type: textarea
76+
id: timeline
77+
attributes:
78+
label: Estimated Timeline
79+
description: Rough estimate of when this feature should be completed (if known)
80+
placeholder: "Q1 2025, Q2 2025, etc."
81+
82+
- type: textarea
83+
id: related
84+
attributes:
85+
label: Related Issues / PRs
86+
description: Link to any related issues, PRs, or discussions
87+
placeholder: |
88+
- Related to #123
89+
- Blocks #456
90+
91+
- type: textarea
92+
id: additional
93+
attributes:
94+
label: Additional Context
95+
description: Any other relevant information about this feature
96+
placeholder: Additional context...
97+

0 commit comments

Comments
 (0)