Skip to content

Commit 466cd78

Browse files
committed
Add basic issue & PR templates
1 parent 5d58ea0 commit 466cd78

File tree

3 files changed

+68
-0
lines changed

3 files changed

+68
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yaml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
If you have a question please search or post to the [Discussions tab](https://github.com/Seelengrab/Supposition.jl/discussions).
10+
We use the GitHub issue tracker for bug reports and feature development only.
11+
- type: textarea
12+
id: what-happened
13+
attributes:
14+
label: What happened?
15+
description: Please describe the steps you took and provide any code executed to reproduce the bug, as well as any error messages that were printed.
16+
placeholder: |
17+
I executed this function:
18+
19+
```julia
20+
[...]
21+
````
22+
23+
and encountered the following error/wrong/unexpected result:
24+
25+
[...]
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: expectation
30+
attributes:
31+
label: What did you expect to happen?
32+
description: Please describe what you expected to happen.
33+
placeholder: I expected the function to return `foobar`.
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: version
38+
attributes:
39+
label: Version
40+
description: What version of julia are you running?
41+
placeholder: In the environment the bug occurred, please run `using InteractiveUtils; versioninfo()` and paste the output here.
42+
render: shell
43+
validations:
44+
required: true
45+
- type: textarea
46+
id: version
47+
attributes:
48+
label: Version
49+
description: What version of Supposition.jl are you using?
50+
placeholder: In the environment the bug occurred, please run `import Pkg; Pkg.status()` and paste the output here.
51+
render: shell
52+
validations:
53+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Question and/or feature request
4+
url: https://github.com/Seelengrab/Supposition.jl/discussions
5+
about: Please ask and answer questions about Supposition.jl, as well as request features, on the Discussions tab.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## PR Description
2+
3+
What does this pull request implement?
4+
Please be as descriptive as possible!
5+
6+
### PR Checklist
7+
8+
- [ ] Tests written
9+
- [ ] Documentation expanded
10+
- [ ] Feature ready for review (if false, please mark the PR as `Draft`!)

0 commit comments

Comments
 (0)