Skip to content

Commit 1d90326

Browse files
ioa747ioa747
authored
Merge pull request #26 from sven-seyfert/add-community-standard-files
Added: Community standard files (like issue templates, PR template).
2 parents a510e6b + b578066 commit 1d90326

5 files changed

Lines changed: 357 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/1-feature-request.yml‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: ⭐ Feature Request
2+
description: Suggest a new feature or improvement to the project.
3+
title: "[FEATURE]: "
4+
labels:
5+
- "enhancement"
6+
- "documentation"
7+
- "help wanted"
8+
- "good first issue"
9+
10+
body:
11+
- type: markdown
12+
id: introduction
13+
attributes:
14+
value: |
15+
Thanks for taking the time to fill out this feature request 💛 it's very appreciated!
16+
Please provide as much detail as possible to help us understand and potentially implement the feature.
17+
18+
- type: textarea
19+
id: feature-description
20+
attributes:
21+
label: What feature would you like, or what problem are you facing?
22+
description: Describe the feature you would like to see implemented or the problem you are experiencing.
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: proposed-solution
28+
attributes:
29+
label: What's your proposed solution?
30+
description: A clear description of the enhancement you propose. Please include relevant information and resources if applicable.
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: screenshots
36+
attributes:
37+
label: Screenshots
38+
description: If applicable, please add screenshots to help explain your request.
39+
validations:
40+
required: false
41+
42+
- type: dropdown
43+
id: assignee
44+
attributes:
45+
label: Do you want to work on this issue/improvement?
46+
options:
47+
- "Maybe"
48+
- "Yes"
49+
- "No"
50+
default: 0
51+
multiple: false
52+
validations:
53+
required: false
54+
55+
- type: textarea
56+
id: extra-info
57+
attributes:
58+
label: Any additional context?
59+
description: Add any other relevant context about your proposed solution.
60+
placeholder: |
61+
Examples:
62+
63+
- The solution will affect other functions (potential script breaking changes) ...
64+
- Influences and relationship to other functionality ...
65+
- My considered alternatives are ...
66+
validations:
67+
required: false
68+
69+
- type: markdown
70+
id: thanks
71+
attributes:
72+
value: |
73+
Thanks for your effort and interest ✌️ in improving the project.

‎.github/ISSUE_TEMPLATE/2-bug-report.yml‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
name: 🪲 Bug Report
2+
description: Report a bug or unexpected behavior to help improve the project.
3+
title: "[BUG]: "
4+
labels:
5+
- "bug"
6+
- "invalid"
7+
8+
body:
9+
- type: markdown
10+
id: introduction
11+
attributes:
12+
value: |
13+
Thanks for taking the time to fill out this bug report 💛 it's very appreciated!
14+
Please provide as much detail as possible to help us identify and fix the issue.
15+
16+
- type: textarea
17+
id: what-happened
18+
attributes:
19+
label: What happened?
20+
description: A clear description of the bug you have found. Please include relevant information and resources if applicable.
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: expected-behavior
26+
attributes:
27+
label: What did you expect to happen?
28+
description: A clear description of what you think the expected behavior should be.
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: reproduction-steps
34+
attributes:
35+
label: Which steps did you take to reproduce the bug?
36+
description: A clear description of the steps taken to reproduce the buggy behavior.
37+
placeholder: |
38+
You know the steps? Please try to follow the format below to provide steps to reproduce.
39+
40+
1. Go to ...
41+
2. Click on ...
42+
3. Scroll down to ...
43+
4. Do this and that ...
44+
5. See error
45+
46+
You don't know the exact steps? Just include any relevant details like:
47+
48+
- What you were trying to do ...
49+
- What went wrong ...
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: screenshots
55+
attributes:
56+
label: Screenshots
57+
description: If applicable, please add screenshots to help explain your problem.
58+
validations:
59+
required: false
60+
61+
- type: dropdown
62+
id: version
63+
attributes:
64+
label: Version
65+
description: What version of the project are you running? See Releases (or TAGs) of the repository.
66+
options:
67+
- latest version
68+
- older version
69+
- unknown
70+
default: 0
71+
multiple: false
72+
validations:
73+
required: true
74+
75+
- type: input
76+
id: specific-version
77+
attributes:
78+
label: Older or unknown version?
79+
description: In case there are no Releases (or TAGs) in the repository yet, please see possible version information within the code base.
80+
placeholder: |
81+
Example: "0.17.1" or "0.5.0 - 2026-01-22"
82+
validations:
83+
required: false
84+
85+
- type: dropdown
86+
id: assignee
87+
attributes:
88+
label: Do you want to work on this issue/fix?
89+
options:
90+
- "Maybe"
91+
- "Yes"
92+
- "No"
93+
default: 0
94+
multiple: false
95+
validations:
96+
required: false
97+
98+
- type: checkboxes
99+
id: system-under-test
100+
attributes:
101+
label: What system are you running?
102+
description: Please select all applicable options where the bug occurred for you.
103+
options:
104+
- label: Windows 11 (x64)
105+
- label: Windows 10 (x64)
106+
- label: Windows 10 (x86)
107+
- label: other Windows version
108+
- label: other operating system
109+
validations:
110+
required: true
111+
112+
- type: textarea
113+
id: extra-info
114+
attributes:
115+
label: Any additional context?
116+
description: Add any other context about the problem or your specific environment here if relevant.
117+
placeholder: |
118+
Examples:
119+
120+
- I am using Browser version ...
121+
- I am using Go version ...
122+
- I am using Node.js version ...
123+
- I am using AutoIt version ...
124+
- I am using .NET (C#) version ...
125+
validations:
126+
required: false
127+
128+
- type: markdown
129+
id: thanks
130+
attributes:
131+
value: |
132+
Thanks for your effort and interest ✌️ in improving the project.

‎.github/ISSUE_TEMPLATE/3-general-question.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: 💬 General Question
2+
description: Ask a general question or start a discussion about the project.
3+
title: "[QUESTION]: "
4+
labels:
5+
- "question"
6+
7+
body:
8+
- type: markdown
9+
id: introduction
10+
attributes:
11+
value: |
12+
Thanks for your interest in the project 💛 feel free to ask any general questions or start a discussion here.
13+
Please provide as much detail as possible to help others understand your question or topic.
14+
15+
- type: textarea
16+
id: question-topic
17+
attributes:
18+
label: What is your question or topic?
19+
description: Clearly state your question or the topic you want to discuss.
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: context
25+
attributes:
26+
label: What context or background information can you provide?
27+
description: Add any relevant details, background, or examples to help others understand your question.
28+
validations:
29+
required: false
30+
31+
- type: textarea
32+
id: prior-attempts
33+
attributes:
34+
label: What have you tried or researched already?
35+
description: Briefly describe any steps you've taken or resources you've checked before posting your question.
36+
validations:
37+
required: false
38+
39+
- type: textarea
40+
id: extra-info
41+
attributes:
42+
label: Any additional comments?
43+
description: Add any other comments, links, or related discussions here.
44+
validations:
45+
required: false
46+
47+
- type: markdown
48+
id: thanks
49+
attributes:
50+
value: |
51+
Thanks for your effort and interest ✌️ in improving the project.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Generally curious?
4+
url: https://github.com/ioa747
5+
about: Feel free to explore my profile and repositories on GitHub.

‎.github/pull_request_template.md‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
> [!IMPORTANT]
2+
> Thanks for your effort and interest 💛 in improving the project. It's very appreciated.
3+
4+
## Description
5+
6+
<!-- Describe the purpose and main changes of this Pull Request (PR), including the problem it solves or the improvement it brings. -->
7+
8+
#### 🔗 Linked GitHub Issues
9+
10+
<!-- In case this addresses a GitHub issue, please link it here. -->
11+
12+
Closes #\<number>
13+
14+
#### 📋 What is the current behavior?
15+
16+
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
17+
18+
#### 🚀 What is the new behavior?
19+
20+
<!-- Please describe the behavior or changes that are being added by this PR. -->
21+
22+
<br>
23+
24+
## Type of changes
25+
26+
- [ ] 🪲 Bugfix (change which fixes an issue)
27+
- [ ] ⭐ New Feature (change which adds functionality)
28+
- [ ] 🔒 Security fix (change which improves security)
29+
- [ ] 🔮 Code style update (formatting, renaming)
30+
- [ ] 🔨 Refactoring (code optimization without functional change)
31+
- [ ] 📚 Documentation (updates to README or docs)
32+
- [ ] ⚙️ Build or CI related changes
33+
- [ ] 🧿 Other type <!-- please describe -->
34+
35+
<br>
36+
37+
## Breaking changes 🔥
38+
39+
<!-- Does this PR introduce breaking changes to existing functionality? If yes, please describe what will break and what users need to do to adapt. -->
40+
41+
- [ ] Yes <!-- please describe -->
42+
- [ ] No
43+
44+
<br>
45+
46+
## How and where was this tested?
47+
48+
#### 🖥️ Describe where you tested your changes
49+
50+
*System:*
51+
52+
- [ ] Windows 11 (x64)
53+
- [ ] Windows 10 (x64)
54+
- [ ] Windows 10 (x86)
55+
- [ ] other Windows version
56+
- [ ] other operating system
57+
58+
*Context:*
59+
60+
- [ ] in Browser \<name and version>
61+
- [ ] with Go \<version>
62+
- [ ] with Node.js \<version>
63+
- [ ] with AutoIt \<version>
64+
- [ ] with .NET (C#) \<version>
65+
- [ ] with ...
66+
67+
#### 🔬 Describe how you tested your changes
68+
69+
- [ ] Manually tested in system and context shown above
70+
- [ ] Ran automatic tests (unit tests, integration tests, etc.)
71+
- [ ] Other ways <!-- please describe -->
72+
73+
<br>
74+
75+
## Checklist
76+
77+
- [ ] I have read and understood the available contributing guidelines.
78+
- [ ] I have ensured my code follows the available code conventions.
79+
- [ ] I have reviewed my changes.
80+
- [ ] I have made corresponding changes to the documentation (if applicable).
81+
- [ ] I have added/updated necessary tests to cover the changes (if applicable).
82+
- [ ] I have checked for potential security implications.
83+
84+
<br>
85+
86+
## Additional context
87+
88+
<!-- Add any other context about the problem or improvement here, if relevant. -->
89+
90+
#### Screenshots
91+
92+
<!-- If relevant, provide before/after comparisons or GIFs of UI changes. -->
93+
94+
#### Note to reviewers
95+
96+
<!-- Add any notes for reviewers here. -->

0 commit comments

Comments
 (0)