Skip to content

Commit 2b10d76

Browse files
ElliottKasoarElliottKasoar
committed
Add issue templates
1 parent b15d1c8 commit 2b10d76

File tree

6 files changed

+160
-0
lines changed

6 files changed

+160
-0
lines changed

‎.github/ISSUE_TEMPLATE/1_new_benchmark.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: New Benchmark
2+
description: Propose or discuss a new benchmark
3+
labels: ["new benchmark"]
4+
body:
5+
6+
- type: textarea
7+
attributes:
8+
label: Summary
9+
description: |
10+
A clear and concise summary of the new benchmark. What application and properties are of interest?
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
attributes:
16+
label: Interactive features
17+
description: |
18+
How would you like to explore the results of your benchmark?
19+
validations:
20+
required: false
21+
22+
- type: textarea
23+
attributes:
24+
label: Category
25+
description: |
26+
Which category does the new benchmark belong in? This can already exist, or you may propose a new one.
27+
validations:
28+
required: false
29+
30+
- type: textarea
31+
attributes:
32+
label: Data availability
33+
description: What reference data is available? If this is theoretical, at what level of theory?
34+
validations:
35+
required: false
36+
37+
- type: textarea
38+
attributes:
39+
label: Computational cost
40+
description: If possible, estimate how long the benchmark would take to run on a typical model.
41+
validations:
42+
required: false
43+
44+
- type: textarea
45+
attributes:
46+
label: Additional context
47+
description: Add any other context, or example implementations.
48+
validations:
49+
required: false

‎.github/ISSUE_TEMPLATE/2_bug_report.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
labels: ["bug"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Summary
8+
description: |
9+
A clear and concise description of the bug, including a minimal reproducible example.
10+
11+
Please include your full output with the complete error message.
12+
validations:
13+
required: true
14+
15+
- type: input
16+
attributes:
17+
label: Platform
18+
description: What operating system and architecture are you using? (e.g. `uname -orsm`)
19+
placeholder: e.g., macOS 14 arm64, Windows 11 x86_64, Ubuntu 20.04 amd64
20+
validations:
21+
required: true
22+
23+
- type: input
24+
attributes:
25+
label: Python version
26+
description: What version of Python are you using? (e.g. `python3 --version`)
27+
placeholder: e.g., Python 3.12.6
28+
validations:
29+
required: false

‎.github/ISSUE_TEMPLATE/3_feature_request.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Feature request
2+
description: Suggest a new feature or improvement
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Please select the `New Benchmark` issue template to propose or discuss new benchmarks.**
9+
10+
- type: textarea
11+
attributes:
12+
label: Summary
13+
description: |
14+
A clear and concise description of what new feature or behaviour you would like to see.
15+
16+
If applicable, please describe the current behaviour as well.
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
attributes:
22+
label: Example
23+
description: Provide an example of how the user experience would change or how the new feature would be used.
24+
validations:
25+
required: false
26+
27+
- type: textarea
28+
attributes:
29+
label: Alternatives
30+
description: A clear and concise description of any alternative solutions or features you've considered.
31+
validations:
32+
required: false
33+
34+
- type: textarea
35+
attributes:
36+
label: Additional context
37+
description: Add any other context or screenshots about the feature request here.
38+
validations:
39+
required: false

‎.github/ISSUE_TEMPLATE/4_question.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Question
2+
description: Ask a question about mlip-testing
3+
labels: ["question"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Please select the `New Benchmark` issue template to propose or discuss new benchmarks.**
9+
10+
- type: textarea
11+
attributes:
12+
label: Question
13+
description: Describe your question in detail.
14+
validations:
15+
required: true
16+
17+
- type: input
18+
attributes:
19+
label: Platform
20+
description: What operating system and architecture are you using? (e.g. `uname -orsm`)
21+
placeholder: e.g., macOS 14 arm64, Windows 11 x86_64, Ubuntu 20.04 amd64
22+
validations:
23+
required: false

‎.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: Documentation
4+
url: https://ddmms.github.io/mlip-testing/
5+
about: Please consult the documentation before creating an issue.

‎.github/PULL_REQUEST_TEMPLATE/new_benchmark.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!--
2+
Thank you for contributing! To help us out with reviewing, please consider the following:
3+
4+
- Does this pull request include a summary of the change? (See below.)
5+
- Does this pull request include a descriptive title?
6+
- Does this pull request include references to any relevant issues?
7+
-->
8+
9+
## Summary
10+
11+
<!-- What's the purpose of the change? What does it do, and why? -->
12+
13+
## Test Plan
14+
15+
<!-- How was it tested? -->

0 commit comments

Comments
 (0)