Skip to content

Commit ea322d0

Browse files
authored
Update issue templates
1 parent 2362652 commit ea322d0

2 files changed

Lines changed: 36 additions & 3 deletions

File tree

.github/ISSUE_TEMPLATE/problem.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
name: Problem
3-
about: For contributors to propose a new model problem
4-
title: "[Model] The problem you want to introduce to this repo"
5-
labels: ''
3+
about: Contributors to propose a new model problem
4+
title: "[Model] Problem name"
5+
labels: model
66
assignees: ''
77

88
---

.github/ISSUE_TEMPLATE/rule.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Rule
3+
about: Contributors to propose a new reduction rule
4+
title: "[Rule] Source problem to target problem"
5+
labels: rule
6+
assignees: ''
7+
8+
---
9+
10+
Source problem: [source problem type name A, e.g. MaximumIndependentSet, find problems we already have here: https://codingthrust.github.io/problem-reductions/]
11+
Target problem: [target problem type name B]
12+
13+
## Algorithm
14+
[
15+
You can show a detailed math decription here, it will be used for coding implementation and the typst manual (for human) writing.
16+
]
17+
18+
## Validation method
19+
[
20+
Proposed method for developing a test dataset (in json) to verify correctness. It is usually by round trip tests. e.g. map an instance A to B, solve B
21+
e.g.1
22+
Generate test dataset from an existing library: https://github.com/GiggleLiu/ProblemReductions.jl
23+
e.g.2
24+
- Source problem instance 1, expected target problem instance 1
25+
- Source problem instance 2, expected target problem instance 2
26+
]
27+
28+
## Round trip example to show
29+
[
30+
The example shown in the typst manual, focus on human verifiability. It usually includes
31+
- a short description to what it is about
32+
- the proposed source problem instance
33+
]

0 commit comments

Comments
 (0)