diff --git a/.github/ISSUE_TEMPLATE/1.bug_report.yml b/.github/ISSUE_TEMPLATE/1.bug_report.yml new file mode 100644 index 0000000..e40d3d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1.bug_report.yml @@ -0,0 +1,75 @@ +name: Bug Report +description: Please do not use bug reports for support issues. +title: '[Bug]: ' +labels: ['status:not-yet-viewed', 'bug'] +assignees: 'bobokun' + +body: + - type: markdown + attributes: + value: > + **THIS IS NOT THE PLACE TO ASK FOR SUPPORT!** + Please use [Notifiarr Discord](https://discord.com/invite/AURf8Yz) and post your question under the `qbit-manage` channel for support issues. + - type: textarea + id: description + attributes: + label: Describe the Bug + description: A clear and concise description of the bug. + validations: + required: true + - type: textarea + id: config + attributes: + label: Config + description: > + Please paste your config.yml here (Remember to remove any sensitive information) + This will be automatically formatted into code, so no need for backticks. + render: yaml + - type: input + id: logs + attributes: + label: Logs + description: > + Please share the relevant log file with the error on [Gist](https://gist.github.com). + placeholder: "https://gist.github.com" + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: "[optional] You may add screenshots to further explain your problem." + - type: dropdown + id: installation + attributes: + label: Installation + description: Which installation method did you use? + options: + - Unraid + - Docker + - Local + - Nix + - Other + validations: + required: true + - type: input + id: version + attributes: + label: Version Number + description: Can be found at the beginning of your log file + placeholder: eg. 3.1.3 + validations: + required: true + - type: dropdown + id: branch + attributes: + label: What branch are you on? + options: + - master + - develop + validations: + required: true + - type: markdown + attributes: + value: | + Make sure to close your issue when it's solved! If you found the solution yourself please comment so that others benefit from it. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/2.feature_request.yml b/.github/ISSUE_TEMPLATE/2.feature_request.yml new file mode 100644 index 0000000..ea67abf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2.feature_request.yml @@ -0,0 +1,52 @@ +name: Feature Request +description: Suggest a new feature for Qbit Manage +title: '[FR]: ' +labels: ['status:not-yet-viewed', 'feature request'] +assignees: 'bobokun' + +body: + - type: markdown + attributes: + value: > + Thanks for taking the time to file a feature request! Please fill out this form as completely as possible. + - type: textarea + id: problem-relation + attributes: + label: Is your feature request related to a problem? Please elaborate. + description: A clear and concise description of what the problem is. + placeholder: eg. I'm always frustrated when... + validations: + required: true + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: checkboxes + id: complications + attributes: + label: Does your solution involve any of the following? + options: + - label: New config option + - label: New command option + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + - type: textarea + id: benefit + attributes: + label: Who will this benefit? + description: Does this feature apply to a great portion of users? + validations: + required: true + - type: textarea + id: additional-info + attributes: + label: Additional Information + description: "[optional] You may provide additional context or screenshots for us to better understand the need of the feature." diff --git a/.github/ISSUE_TEMPLATE/3.docs_request.yml b/.github/ISSUE_TEMPLATE/3.docs_request.yml new file mode 100644 index 0000000..cfadd90 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3.docs_request.yml @@ -0,0 +1,25 @@ +name: 'Docs Request for an Update or Improvement' +description: A request to update or improve Qbit Manage documentation +title: '[Docs]: ' +labels: ['status:not-yet-viewed', 'documentation'] +assignees: 'bobokun' + +body: + - type: textarea + attributes: + label: What is the improvement or update you wish to see? + description: 'Example: I would like to see more examples of how to use the `` component. Or, the `` component docs are missing information.' + validations: + required: true + - type: textarea + attributes: + label: Is there any context that might help us understand? + description: A clear description of any added context that might help us understand. + validations: + required: true + - type: input + attributes: + label: Does the docs page already exist? Please link to it. + description: 'Example: https://github.com/StuffAnThings/qbit_manage/wiki/existingpagehere' + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..6b0188f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Qbit Manage Wiki + url: https://github.com/StuffAnThings/qbit_manage/wiki + about: Please check the wiki to see if your question has already been answered. + - name: Notifiarr Discord + url: https://discord.com/invite/AURf8Yz + about: Please post your question under the `qbit-manage` channel for support issues. + - name: Ask a question + url: https://github.com/StuffAnThings/qbit_manage/discussions + about: Ask questions and discuss with other community members \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..cd1bdba --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,29 @@ + + +## Description + +Please include a summary of the change and which issue is fixed. + +Fixes # (issue) + +## Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + + +## Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have added or updated the docstring for new or existing methods +- [ ] I have added tests when applicable \ No newline at end of file