Skip to content

Commit 43ff321

Browse files
committed
Upload Issue Templates
The issue templates have been uploaded.
1 parent 436aecd commit 43ff321

File tree

5 files changed

+159
-1
lines changed

5 files changed

+159
-1
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: "\U0001F41BBug report"
2+
description: Create a report to help us improve arg-classifier.
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report! Please write a clear and concise description of what the bug is.
9+
- type: input
10+
id: version
11+
attributes:
12+
label: Version
13+
description: Which version of the arg-classifier is?
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: expected-behavior
18+
attributes:
19+
label: Expected behavior
20+
description: Please write a clear and concise description of what you expected to happen.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: environment
25+
attributes:
26+
label: Environment
27+
description: |
28+
Please provide us your environment information. You can view this information by entering the following command:
29+
```shell
30+
systeminfo
31+
```
32+
Note: avoid pasting/sharing personal data.
33+
value: |
34+
- OS: [e.g. Windows 11]
35+
- Python version: [e.g. 3.11.x]
36+
- JDK or JRE: [e.g. 17]
37+
- (Optional) Other libraries and their versions:
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: logs
42+
attributes:
43+
label: Error messages, stack traces, or logs
44+
description: Please copy and paste any relevant error messages, stack traces, or log output.
45+
render: shell
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: steps-to-reproduce
50+
attributes:
51+
label: Steps to reproduce
52+
description: Please provide how we reproduce your reported bugs. If possible, it is highly recommended to provide the reproducible example codes.
53+
value: |
54+
1. Go to '...'
55+
2. Click on '....'
56+
3. Scroll down to '....'
57+
4. See error
58+
```java
59+
// Java code
60+
```
61+
validations:
62+
required: true
63+
- type: textarea
64+
id: additional-context
65+
attributes:
66+
label: Additional context (optional)
67+
description: Please add any other context or screenshots if you have.
68+
validations:
69+
required: false

.github/ISSUE_TEMPLATE/code-fix.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: "\U0001F6A7Code fix"
2+
description: Suggest a code fix that does not change the behaviors of arg-classifier, such as code refactoring.
3+
labels: ["code-fix"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to raise a new issue! Please write a clear and concise description of the code fix.
9+
- type: input
10+
id: version
11+
attributes:
12+
label: Version
13+
description: Which version of the arg-classifier is?
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: motivation
18+
attributes:
19+
label: Motivation
20+
description: |
21+
Please write the motivation for the proposal.
22+
If your code fix is related to a problem, please describe a clear and concise description of what the problem is.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: suggestion
27+
attributes:
28+
label: Suggestion
29+
description: Please explain your suggestion for the code change.
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: additional-context
34+
attributes:
35+
label: Additional context (optional)
36+
description: Please add any other context or screenshots if you have.
37+
validations:
38+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: "\U00002753Questions"
5+
url: "https://github.com/argrecsys/arg-classifier/discussions"
6+
about: "Use the GitHub Discussions to ask support questions."
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: "\U0001F4A1Feature request"
2+
description: Suggest an idea to improve arg-classifier.
3+
labels: ["feature"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time for your feature requests! Please write a clear and concise description of the feature proposal.
9+
- type: input
10+
id: version
11+
attributes:
12+
label: Version
13+
description: Which version of the arg-classifier is?
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: motivation
18+
attributes:
19+
label: Motivation
20+
description: |
21+
Please write the motivation for the proposal.
22+
If your feature request is related to a problem, please describe a clear and concise description of what the problem is.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: description
27+
attributes:
28+
label: Description
29+
description: Please write a detailed description of the new feature.
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: alternatives
34+
attributes:
35+
label: Alternatives (optional)
36+
description: Please write a clear and concise description of any alternative solutions or features you've considered.
37+
validations:
38+
required: false
39+
- type: textarea
40+
id: additional-context
41+
attributes:
42+
label: Additional context (optional)
43+
description: Please add any other context or screenshots if you have.
44+
validations:
45+
required: false

docs/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Have you identified an oversight or problem? Have a feature request? We want to
1414
> **Note:** If you already know what you want to change, feel free to just fork/clone the repo, change it, and submit a pull request. No need to add overhead by creating an issue!
1515
1616
### Look For an Existing Issue
17-
Before you create a new issue, please do a search in [open issues](https://github.com/argrecsys/arg-ir-tool/issues) to see if the issue or feature request has already been filed.
17+
Before you create a new issue, please do a search in [open issues](https://github.com/argrecsys/arg-classifier/issues) to see if the issue or feature request has already been filed.
1818

1919
If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.
2020

0 commit comments

Comments
 (0)