diff --git a/.github/ISSUE_TEMPLATE/1-feature-request.yml b/.github/ISSUE_TEMPLATE/1-feature-request.yml new file mode 100644 index 00000000..258fc063 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-feature-request.yml @@ -0,0 +1,73 @@ +name: ⭐ Feature Request +description: Suggest a new feature or improvement to the project. +title: "[FEATURE]: " +labels: + - "enhancement" + - "documentation" + - "help wanted" + - "good first issue" + +body: + - type: markdown + id: introduction + attributes: + value: | + Thanks for taking the time to fill out this feature request 💛 it's very appreciated! + Please provide as much detail as possible to help us understand and potentially implement the feature. + + - type: textarea + id: feature-description + attributes: + label: What feature would you like, or what problem are you facing? + description: Describe the feature you would like to see implemented or the problem you are experiencing. + validations: + required: true + + - type: textarea + id: proposed-solution + attributes: + label: What's your proposed solution? + description: A clear description of the enhancement you propose. Please include relevant information and resources if applicable. + validations: + required: true + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, please add screenshots to help explain your request. + validations: + required: false + + - type: dropdown + id: assignee + attributes: + label: Do you want to work on this issue/improvement? + options: + - "Maybe" + - "Yes" + - "No" + default: 0 + multiple: false + validations: + required: false + + - type: textarea + id: extra-info + attributes: + label: Any additional context? + description: Add any other relevant context about your proposed solution. + placeholder: | + Examples: + + - The solution will affect other functions (potential script breaking changes) ... + - Influences and relationship to other functionality ... + - My considered alternatives are ... + validations: + required: false + + - type: markdown + id: thanks + attributes: + value: | + Thanks for your effort and interest ✌️ in improving the project. diff --git a/.github/ISSUE_TEMPLATE/2-bug-report.yml b/.github/ISSUE_TEMPLATE/2-bug-report.yml new file mode 100644 index 00000000..3a6bfd13 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-bug-report.yml @@ -0,0 +1,132 @@ +name: 🪲 Bug Report +description: Report a bug or unexpected behavior to help improve the project. +title: "[BUG]: " +labels: + - "bug" + - "invalid" + +body: + - type: markdown + id: introduction + attributes: + value: | + Thanks for taking the time to fill out this bug report 💛 it's very appreciated! + Please provide as much detail as possible to help us identify and fix the issue. + + - type: textarea + id: what-happened + attributes: + label: What happened? + description: A clear description of the bug you have found. Please include relevant information and resources if applicable. + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: What did you expect to happen? + description: A clear description of what you think the expected behavior should be. + validations: + required: true + + - type: textarea + id: reproduction-steps + attributes: + label: Which steps did you take to reproduce the bug? + description: A clear description of the steps taken to reproduce the buggy behavior. + placeholder: | + You know the steps? Please try to follow the format below to provide steps to reproduce. + + 1. Go to ... + 2. Click on ... + 3. Scroll down to ... + 4. Do this and that ... + 5. See error + + You don't know the exact steps? Just include any relevant details like: + + - What you were trying to do ... + - What went wrong ... + validations: + required: true + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, please add screenshots to help explain your problem. + validations: + required: false + + - type: dropdown + id: version + attributes: + label: Version + description: What version of the project are you running? See Releases (or TAGs) of the repository. + options: + - latest version + - older version + - unknown + default: 0 + multiple: false + validations: + required: true + + - type: input + id: specific-version + attributes: + label: Older or unknown version? + description: In case there are no Releases (or TAGs) in the repository yet, please see possible version information within the code base. + placeholder: | + Example: "0.17.1" or "0.5.0 - 2026-01-22" + validations: + required: false + + - type: dropdown + id: assignee + attributes: + label: Do you want to work on this issue/fix? + options: + - "Maybe" + - "Yes" + - "No" + default: 0 + multiple: false + validations: + required: false + + - type: checkboxes + id: system-under-test + attributes: + label: What system are you running? + description: Please select all applicable options where the bug occurred for you. + options: + - label: Windows 11 (x64) + - label: Windows 10 (x64) + - label: Windows 10 (x86) + - label: other Windows version + - label: other operating system + validations: + required: true + + - type: textarea + id: extra-info + attributes: + label: Any additional context? + description: Add any other context about the problem or your specific environment here if relevant. + placeholder: | + Examples: + + - I am using Browser version ... + - I am using Go version ... + - I am using Node.js version ... + - I am using AutoIt version ... + - I am using .NET (C#) version ... + validations: + required: false + + - type: markdown + id: thanks + attributes: + value: | + Thanks for your effort and interest ✌️ in improving the project. diff --git a/.github/ISSUE_TEMPLATE/3-general-question.yml b/.github/ISSUE_TEMPLATE/3-general-question.yml new file mode 100644 index 00000000..955080d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-general-question.yml @@ -0,0 +1,51 @@ +name: 💬 General Question +description: Ask a general question or start a discussion about the project. +title: "[QUESTION]: " +labels: + - "question" + +body: + - type: markdown + id: introduction + attributes: + value: | + Thanks for your interest in the project 💛 feel free to ask any general questions or start a discussion here. + Please provide as much detail as possible to help others understand your question or topic. + + - type: textarea + id: question-topic + attributes: + label: What is your question or topic? + description: Clearly state your question or the topic you want to discuss. + validations: + required: true + + - type: textarea + id: context + attributes: + label: What context or background information can you provide? + description: Add any relevant details, background, or examples to help others understand your question. + validations: + required: false + + - type: textarea + id: prior-attempts + attributes: + label: What have you tried or researched already? + description: Briefly describe any steps you've taken or resources you've checked before posting your question. + validations: + required: false + + - type: textarea + id: extra-info + attributes: + label: Any additional comments? + description: Add any other comments, links, or related discussions here. + validations: + required: false + + - type: markdown + id: thanks + attributes: + value: | + Thanks for your effort and interest ✌️ in improving the project. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 7eec495f..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -## Bug report - -### Describe the bug - -A clear and concise description of what the bug is. - -### How to reproduce - -Steps to reproduce the behavior (e.g.): - -1. Go to '...' -2. Click on '...' -3. Scroll down to '...' -4. See error - -### Expected behavior - -A clear and concise description of what you expected to happen. - -### Screenshots - -If applicable, add screenshots to help explain your problem. - -### Additional context - -Add any other context about the problem here. - -### System under test - -Please complete the following information. - -- OS: [e.g. Windows 10] -- OS Arch.: [e.g. X64] -- Browser [e.g. firefox] -- Browser version [e.g. 96.0.3] diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..943116b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Generally curious? + url: https://github.com/Danp2 + about: Feel free to explore my profile and repositories on GitHub. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index d0083c34..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -## Feature request - -### Is your feature request related to a problem? Please describe - -A clear and concise description of what the problem is. For example: I'm always frustrated when [...] . - -### Describe the solution you'd like - -A clear and concise description of what you want to happen. - -### Describe alternatives you've considered - -A clear and concise description of any alternative solutions or features you've considered. - -### Additional context - -Add any other context or screenshots about the feature request here. - -### Influences and relationship to other functionality - -Describe how the changes will affect other functions, potential script breaking changes, etc. - diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..0620acb5 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,96 @@ +> [!IMPORTANT] +> Thanks for your effort and interest 💛 in improving the project. It's very appreciated. + +## Description + + + +#### 🔗 Linked GitHub Issues + + + +Closes #\ + +#### 📋 What is the current behavior? + + + +#### 🚀 What is the new behavior? + + + +
+ +## Type of changes + +- [ ] 🪲 Bugfix (change which fixes an issue) +- [ ] ⭐ New Feature (change which adds functionality) +- [ ] 🔒 Security fix (change which improves security) +- [ ] 🔮 Code style update (formatting, renaming) +- [ ] 🔨 Refactoring (code optimization without functional change) +- [ ] 📚 Documentation (updates to README or docs) +- [ ] ⚙️ Build or CI related changes +- [ ] 🧿 Other type + +
+ +## Breaking changes 🔥 + + + +- [ ] Yes +- [ ] No + +
+ +## How and where was this tested? + +#### 🖥️ Describe where you tested your changes + +*System:* + +- [ ] Windows 11 (x64) +- [ ] Windows 10 (x64) +- [ ] Windows 10 (x86) +- [ ] other Windows version +- [ ] other operating system + +*Context:* + +- [ ] in Browser \ +- [ ] with Go \ +- [ ] with Node.js \ +- [ ] with AutoIt \ +- [ ] with .NET (C#) \ +- [ ] with ... + +#### 🔬 Describe how you tested your changes + +- [ ] Manually tested in system and context shown above +- [ ] Ran automatic tests (unit tests, integration tests, etc.) +- [ ] Other ways + +
+ +## Checklist + +- [ ] I have read and understood the available contributing guidelines. +- [ ] I have ensured my code follows the available code conventions. +- [ ] I have reviewed my changes. +- [ ] I have made corresponding changes to the documentation (if applicable). +- [ ] I have added/updated necessary tests to cover the changes (if applicable). +- [ ] I have checked for potential security implications. + +
+ +## Additional context + + + +#### Screenshots + + + +#### Note to reviewers + +