-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add issue templates for bug reports, feature requests, and que…
…stions Resolves: #72
- Loading branch information
1 parent
3d1516e
commit a356077
Showing
3 changed files
with
101 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
name: Bug report | ||
description: Report any unexpected behavior, errors, or malfunctions you have observed. | ||
labels: [bug] | ||
|
||
body: | ||
|
||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for taking the time to report a bug. To assist in effectively addressing the issue you have encountered, please provide the following information. Before creating a new issue, we kindly request checking the issue tracker for any existing reports related to the bug. | ||
- type: textarea | ||
id: bug-description | ||
attributes: | ||
label: Bug description | ||
description: A clear and concise description of what the bug is. | ||
placeholder: I was trying to do X, but Y happened instead. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: code-example | ||
attributes: | ||
label: Reproducible code example | ||
description: A code example that reproduces the bug. | ||
placeholder: | | ||
from semanticscholar import SemanticScholar | ||
sch = SemanticScholar() | ||
<< your code here >> | ||
render: Python | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: error-message | ||
attributes: | ||
label: Error message | ||
description: The error message you received. Please include the full traceback. | ||
placeholder: | | ||
Traceback (most recent call last): | ||
File "<stdin>", line 1, in <module> | ||
AttributeError: 'Author' object has no attribute 'names' | ||
render: Shell | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: package-version | ||
attributes: | ||
label: Package version | ||
description: The version of the package you are using. | ||
placeholder: 0.1.0 | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: python-version | ||
attributes: | ||
label: Python version | ||
description: The version of Python you are using. | ||
placeholder: 3.11.0 | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
name: Feature request / Suggestion / Enhancement | ||
description: Suggest a new feature or enhancement for the package. | ||
labels: [enhancement] | ||
|
||
body: | ||
|
||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for taking the time to suggest a new feature or enhancement. To ensure an organized and efficient process, we kindly request that you check the issue tracker before creating a new request to avoid duplicates. | ||
- type: textarea | ||
id: proposed-change-description | ||
attributes: | ||
label: Proposed change description | ||
description: A clear and concise description of the proposed change. Please include any relevant motivation, context, or examples. Also, alternative solutions or features you've considered would be apreciated. | ||
placeholder: I would like to see FEATURE added to the package. | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
name: Question | ||
description: Ask a question about the package. | ||
labels: [question] | ||
|
||
body: | ||
|
||
- type: markdown | ||
attributes: | ||
value: | | ||
Before creating a new issue, we kindly request checking the issue tracker for any existing related questions. | ||
- type: textarea | ||
id: question | ||
attributes: | ||
label: Question | ||
description: A clear and concise question about the package. | ||
placeholder: How do I do X? | ||
validations: | ||
required: true |