Skip to content

Commit

Permalink
add issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
spyoungtech committed Mar 9, 2024
1 parent 3f11d3a commit 0a57784
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 0 deletions.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/00_bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: bug report
description: something went wrong
body:
- type: markdown
attributes:
value: |
Please use this issue template to report bug behavior
- type: textarea
id: what-happened
attributes:
label: describe your issue
description: Please describe the problem, the expected behavior, and the actual behavior
placeholder: |
I was doing ...
I ran ...
I expected ...
I got ...
validations:
required: true
- type: input
id: library-version
attributes:
label: ahk.__version__
placeholder: 1.x.x
validations:
required: false
- type: input
id: ahk-version
attributes:
label: AutoHotkey version
placeholder: v1 or v2
validations:
required: false
- type: textarea
id: code
attributes:
label: Code to reproduce the issue
description: Minimal Python code that can be used to reproduce the issue. (no backticks needed)
placeholder: |
from ahk import AHK
ahk = AHK()
ahk.do_something()
render: python
validations:
required: false
- type: textarea
id: error-log
attributes:
label: 'Traceback/Error message'
description: The full traceback/error you receive or other error information, if applicable
placeholder: |
Traceback (most recent call last):
File "C:\path\to\yourscript.py", line 3, in <module>
ahk.failure()
File "C:\path\to\site-packages\ahk\_sync\engine.py", line 220, in __getattr__
raise AttributeError(f'{self.__class__.__name__!r} object has no attribute {name!r}')
AttributeError: 'AHK' object has no attribute 'failure'
validations:
required: false
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/01_feature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: feature request
description: something new
body:
- type: markdown
attributes:
value: |
Use this form to create feature requests
- type: checkboxes
attributes:
label: Checked the documentation
description: |
The documentation contains information about features that are already implemented. Please check this first before making a request.
(requests for features marked as "Not Implemented" in the documentation are OK, but please provide context on how you want to use this feature).
options:
- label: I have checked [the documentation](https://ahk.readthedocs.io/en/latest/api/methods.html) for the feature I am requesting
required: true


- type: textarea
id: freeform
attributes:
label: describe your feature request
placeholder: |
I want to do ...
I tried ...
It does not work because ...
This feature would be useful because ...
Additional information can be found at https://www.autohotkey.com/docs/ ...
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: documentation
url: https://ahk.readthedocs.io/en/latest/
about: See the full documentation

0 comments on commit 0a57784

Please sign in to comment.