Skip to content

Commit

Permalink
Issue #114: Fix Github example issue message. This references telegra…
Browse files Browse the repository at this point in the history
…m-upload.
  • Loading branch information
Nekmo committed Jul 3, 2023
1 parent 675edba commit b3771b7
Show file tree
Hide file tree
Showing 6 changed files with 174 additions and 16 deletions.
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

91 changes: 91 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
name: Bug Report
description: Create a report about a bug inside the application.
body:

- type: textarea
id: reproducing-example
attributes:
label: Command that causes the issue
description: Provide the command that reproduces the problem. If possible, indicate the websites that produces the bug or attach the files.
placeholder: |
```bash
~ $ dirhunt http://example.com
```
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: Explain what you should expect to happen. Include reproduction steps.
placeholder: |
"I was doing... I was expecting the following to happen..."
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: Explain what actually happens.
placeholder: |
"This happened instead..."
validations:
required: true

- type: textarea
id: traceback
attributes:
label: Traceback
description: |
The traceback (the error), if the problem is a crash.
placeholder: |
```
Traceback (most recent call last):
File "/usr/lib/python3.11/site-packages/dirhunt/scripts/dirhunt", line 6, in <module>
catch(hunt)()
```
- type: textarea
id: dirhunt-version
attributes:
label: Dirhunt version
description: The output of `dirhunt --version`.
placeholder: |
```
You are running Dirhunt v1.0.0 using Python 3.11.3.
This is the latest release
Installation path: /usr/lib/python3.11/site-packages/dirhunt
Current path: /home/user/
```
validations:
required: true

- type: input
id: os
attributes:
label: Operating system (including distribution name and version)
placeholder: Windows 11, macOS 13.4, Ubuntu 23.04...
validations:
required: true

- type: textarea
id: other-details
attributes:
label: Other details
placeholder: |
Additional details and attachments. Is it a server? Network condition?
- type: checkboxes
id: checklist
attributes:
label: Checklist
description: Read this carefully, we will close and ignore your issue if you skimmed through this.
options:
- label: The error is in the project's code, and not in my own.
required: true
- label: I have searched for this issue before posting it and there isn't an open duplicate.
required: true
- label: I ran `pip install -U dirhunt` and triggered the bug in the latest version.
required: true
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Dirhunt documentation
url: https://docs.nekmo.org/dirhunt/
about: Dirhunt official documentation. You can find here all the information about Dirhunt.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Documentation Issue
description: Report a problem with the documentation.
labels: [documentation]
body:

- type: textarea
id: description
attributes:
label: Description
description: Describe the problem in detail.
placeholder: This part is unclear...
validations:
required: true

- type: input
id: url
attributes:
label: URL
description: The URL of the page with the problem.
placeholder: https://docs.nekmo.org/dirhunt/...

- type: checkboxes
id: checklist
attributes:
label: Checklist
description: Read this carefully, we will close and ignore your issue if you skimmed through this.
options:
- label: This is a documentation problem, not a question or a bug report.
required: true
- label: I have searched for this issue before posting it and there isn't a duplicate.
required: true
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Feature Request
description: Suggest ideas, changes or other enhancements for the application.
labels: [enhancement]
body:

- type: textarea
id: feature-description
attributes:
label: Describe your suggested feature
description: Please describe your idea. Would you like another friendly feature? Renaming them to something more appropriate? Changing the way something works?
placeholder: "It should work like this..."
validations:
required: true

- type: checkboxes
id: checklist
attributes:
label: Checklist
description: Read this carefully, we will close and ignore your issue if you skimmed through this.
options:
- label: I have searched for this issue before posting it and there isn't a duplicate.
required: true
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Application question
description: Questions about Dirhunt, doubts and other issues.
labels: [question]
body:

- type: textarea
id: description
attributes:
label: Description
description: Describe the question in detail.
placeholder: I have searched the Dirhunt documentation on a topic and I have not found any help about...
validations:
required: true

- type: checkboxes
id: checklist
attributes:
label: Checklist
description: Read this carefully, we will close and ignore your issue if you skimmed through this.
options:
- label: I have read the documentation and I have not found it.
required: true
- habel: This is a question or something else. This is not a bug report, a feature request or a documentation issue.
required: true
- label: I have searched for this issue before posting it and there isn't a duplicate.
required: true

0 comments on commit b3771b7

Please sign in to comment.